id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_sr_e545b10caa43
unity_docs
scripting
What is `UIElements.UxmlValueMatches.Equals` in Unity? Explain its purpose and usage.
UxmlValueMatches.Equals Declaration public bool Equals ( UIElements.UxmlTypeRestriction other ); Parameters Parameter Description other The object to compare with. Returns bool True if the otheer object is equal to this one. Description Indicates whether the current UxmlValueMatches object is equ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ed36cfbf5ef2
unity_docs
rendering
What are the parameters of `GUI.BeginGroup` in Unity?
Description Begin a group. Must be matched with a call to EndGroup . When you begin a group, the coordinate system for GUI controls are set so (0,0) is the top-left corner of the group. All controls are clipped to the group. Groups can be nested - if they are, children are clipped to their parents. This is very useful ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c83cff320a78
unity_docs
scripting
Show me a Unity C# example demonstrating `Search.SearchExpression.FormatItem`.
cription ctx SearchContext that yielded the SearchItem. item SearchItem to select value from. formatString Format string that mayh contain selectors. Returns string Returns a string where selectors have been replaced by the selected values from a given SearchItem. Description Take a format string and repl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28028a523921
unity_docs
rendering
What is `Rendering.GraphicsSettings.disableBuiltinCustomRenderTextureUpdate` in Unity? Explain its purpose and usage.
GraphicsSettings.disableBuiltinCustomRenderTextureUpdate public static bool disableBuiltinCustomRenderTextureUpdate ; Description Disables the built-in update loop for Custom Render Textures, so that you can write your own update loop. When this is set to true, Unity does not call internally CustomRenderTexture...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d73200176c4e
unity_docs
scripting
What is `Rendering.CommandBuffer.SetBufferCounterValue` in Unity? Explain its purpose and usage.
CommandBuffer.SetBufferCounterValue Declaration public void SetBufferCounterValue ( ComputeBuffer buffer , uint counterValue ); Declaration public void SetBufferCounterValue ( GraphicsBuffer buffer , uint counterValue ); Parameters Parameter Description buffer The destination buffer. counterValue ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cdc589509a41
unity_docs
math
What is `Mesh.MeshDataArray` in Unity? Explain its purpose and usage.
MeshDataArray struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description An array of Mesh data snapshots for C# Job System access. Access to most Unity objects is not thread-safe, so in order to efficiently process or create meshes from the C# Job System, use the MeshDataArray and MeshData ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ba873da365d
unity_docs
scripting
Show me a Unity C# example demonstrating `Microphone.devices`.
Microphone.devices public static string[] devices ; Description A list of available microphone devices, identified by name. You can use the name with the Start and End functions to specify which microphone you wish to start/stop recording. ```csharp using UnityEngine;public class Example : MonoBehaviour {...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_541c10bf3c80
unity_docs
scripting
What is `Animations.ScaleConstraint` in Unity? Explain its purpose and usage.
ScaleConstraint class in UnityEngine.Animations / Inherits from: Behaviour / Implemented in: UnityEngine.AnimationModule Implements interfaces: IConstraint Description Constrains the scale of an object relative to the scale of one or more source objects. Properties Property Description constraintActive Ac...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_946291eb1c3c_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Centralized logging with levels and filtering Signature: ```csharp public static class DebugLogger ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
gh_5c55785f12e7
github
scripting
Write a Unity C# UI script for Splash Screen Process
```csharp using System; using System.Threading; using Cysharp.Threading.Tasks; using UnityEngine; using VContainer; namespace AntiMonoBehaviour.Processes { public interface ISplashScreenParams { GameObject SplashScreenViewPrefab { get; } float SplashScreenSeconds { get; } } public cla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d44a84a19a6d
github
scripting
Write a Unity C# MonoBehaviour script called New Behaviour Script
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; public class NewBehaviourScript : MonoBehaviour { public float lifeTime; // Update is called once per frame private void Update() { lifeTime -= Time.deltaTime; if (lifeTime < 0){ Destro...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_36f333d2c913
unity_docs
editor
Explain 'Create a simple transition with UI Builder and C# scripts' in Unity.
Version: 2021.3+ This example demonstrates how to create simple transitions that are triggered by pseudo-classes and C# events. ## Example overview The example creates a custom Editor window with three labels that rotate and scale when you hover over them. The transition lasts for three seconds. You can find the comp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca6021a0cb5b
unity_docs
scripting
What are the parameters of `Pool.IObjectPool_1.Get` in Unity?
Returns PooledObject<T> A PooledObject that will return the instance back to the pool when its Dispose method is called. Description Returns a PooledObject that will automatically return the instance to the pool when it is disposed. ```csharp using System.Text; using UnityEngine; using UnityEngine.Pool;public class Exa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e1476e5624f
unity_docs
rendering
What is `LightTransport.PostProcessing.RadeonRaysProbePostProcessor.Initialize` in Unity? Explain its purpose and usage.
RadeonRaysProbePostProcessor.Initialize Declaration public bool Initialize ( LightTransport.IDeviceContext context ); Parameters Parameter Description context Device context. Returns bool True if the initialization was successful. Description Initialize the RadeonRaysProbePostProcessor . Must be c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_921bc679d695
unity_docs
scripting
What is `Unity.Hierarchy.Hierarchy.ReserveChildren` in Unity? Explain its purpose and usage.
Hierarchy.ReserveChildren Declaration public void ReserveChildren (ref Unity.Hierarchy.HierarchyNode node , int count ); Parameters Parameter Description node The hierarchy node. count The number of children nodes to reserve memory for. Description Ensures that the hierarchy node has enough memory re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_70a7eecc1a1c
unity_docs
scripting
Give me an overview of the `ReflectionProbe` class in Unity.
ReflectionProbe class in UnityEngine / Inherits from: Behaviour / Implemented in: UnityEngine.CoreModule Description The reflection probe is used to capture the surroundings into a texture which is passed to the shaders and used for reflections. The properties are an exact match for the values shown in the I...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0b19bb4bd12b
unity_docs
ui
What is `UIElements.UIToolkitInputBackendOption.LegacyBackend` in Unity? Explain its purpose and usage.
UIToolkitInputBackendOption.LegacyBackend Description The legacy backend relies on the Input Manager UnityEngine.Input class only and is not compatible with the Input System package. This option will always try to use the old Input Manager. If the Input Manager is not enabled as an active input handler, UI Toolki...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6a8306c1639f
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R16_SNorm` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R16_SNorm Description A one-component, 16-bit signed normalized format that has a single 16-bit R component.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_278e2d35572e
unity_docs
rendering
In Unity's 'Tree Editor concepts', what is 'Tree levels and groups' and how does it work?
The Tree Editor manages branches and leaves in groups, and arranges the groups in levels. The tree root doesn’t count as one of the levels, so the first level is the trunk. Branches growing directly from the trunk are the primary level. Branches growing from the primary branches are the secondary level. The branching p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9119ed3a385b
unity_docs
scripting
What is `ReflectionProbe` in Unity? Explain its purpose and usage.
ReflectionProbe class in UnityEngine / Inherits from: Behaviour / Implemented in: UnityEngine.CoreModule Description The reflection probe is used to capture the surroundings into a texture which is passed to the shaders and used for reflections. The properties are an exact match for the values shown in the I...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3fcc833e2ce8
unity_docs
rendering
In Unity's 'Configure shadow resolution in the Built-In Render Pipeline', what is 'Override shadow map resolution' and how does it work?
In the Built-in Render Pipeline , you can set the resolution of a Light’s shadow map by setting the Light.shadowCustomResolution property to a value greater than 0. When this value is greater than 0, Unity performs the following calculation for all Light types: NextPowerOfTwo (shadowCustomResolution) It then clamps the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4f33bcda99e8
unity_docs
rendering
Show me a Unity code example for 'Make shader behavior conditional on keywords'.
To mark parts of your shader code conditional based on whether you enable or disable a shader keyword, use an HLSL if statement . For example: ``` #pragma multi_compile QUALITY_LOW QUALITY_MED QUALITY_HIGH if (QUALITY_LOW) { // code for low quality setting } else if (QUALITY_MED) { // code for medium quality setting...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_954f9ad260ac
unity_docs
editor
Show me a Unity C# example demonstrating `GUILayout.ScrollViewScope`.
ngine / Implemented in: UnityEngine.IMGUIModule Description Disposable helper class for managing BeginScrollView / EndScrollView . Automatically laid out scrollviews will take whatever content you have inside them and display normally. If it doesn't fit, scrollbars will appear. A call to BeginScrollView must a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4e524db5abe8
github
scripting
Write a Unity Editor script for Pool Datum Drawer
```csharp #if UNITY_EDITOR using System; using System.Collections.Generic; using System.Linq; using UnityEditor; using UnityEngine; namespace Pool.Runtime { /// <summary> /// Custom property drawer for the PoolDatum structure in the Unity Editor. /// This drawer customizes how the fields of PoolDatum are ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f080653012cc
unity_docs
editor
What is `Callbacks.RunBeforePackageAttribute` in Unity? Explain its purpose and usage.
RunBeforePackageAttribute class in UnityEditor.Callbacks Description Add this attribute to a callback method to mark that this callback must be run before any callbacks that are part of the specified package. To define dependencies for a callback, use the following attributes: RunAfterClassAttribute , RunBefore...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a12079ac51de
unity_docs
editor
What is `ObjectChangeEvents.changesPublished` in Unity? Explain its purpose and usage.
ObjectChangeEvents.changesPublished Parameters Parameter Description value The stream of events that have been recorded since the last frame. Description Event that is raised once per frame if any undoable changes have been recorded. All undoable changes to any loaded object are recorded in a stream of events ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_021ffd5dd06a
unity_docs
scripting
What is `Unity.Properties.VisitExceptionKind` in Unity? Explain its purpose and usage.
VisitExceptionKind enumeration Description Flags used to specify a set of exceptions. Properties Property Description None Flag used to specify no exception types. Internal Flag used to specify internal exceptions thrown by the core visitation. Visitor Use this flag to specify exceptions thrown f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_24b08c30d158
unity_docs
ui
In Unity's 'Best practices for USS', what is 'Complex selectors hierarchy guidelines' and how does it work?
In general, complex selectors have more impact on performance than simple selectors. Complex selectors depend on the ancestors of an element to match it. When possible, consider the following: If you want to have partial match, use the child selector ( selector1 > selector2 > selector3 ) instead of the descendant selec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d792cb9ced5a
unity_docs
scripting
What is `AndroidJavaObject.Set` in Unity? Explain its purpose and usage.
AndroidJavaObject.Set Declaration public void Set (string fieldName , FieldType val ); Parameters Parameter Description fieldName The name of the field (e.g. int counter; would have fieldName = "counter"). val The value to assign to the field. It has to match the field type. Description Set the value ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7c1077489528
unity_docs
math
What is `Rendering.RayTracingAccelerationStructureBuildFlags` in Unity? Explain its purpose and usage.
RayTracingAccelerationStructureBuildFlags enumeration Description Specifies how Unity builds the acceleration structure on the GPU. Note that some flags might not be compatible with each other. Additional resources: Settings , RayTracingMeshInstanceConfig , RayTracingAABBsInstanceConfig , BuildSettings . Prop...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_49d7554b6575_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Called whenever the register specified in the constructor changes value. Signature: ```csharp public Action<ushort[]> OnRegisterChange; ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_e8b88d456a00
unity_docs
editor
What is `Experimental.Rendering.IScriptableBakedReflectionSystemStageNotifier` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. IScriptableBakedReflectionSystemStageNotifier interface in UnityEditor.Experimental.Rendering Description An implementation of this interface is provided while ticking an ScriptableBakedReflectionSystem. (See IScriptableBakedR...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a3e99216309b
unity_docs
scripting
In Unity's 'Creating, loading, and saving scenes', what is 'Creating a new scene from the menu:' and how does it work?
Use the menu ( Assets > Create > Scene ) to create a new scene without opening the New Scene dialog. When you create a new scene from the menu, Unity automatically copies the project’s Basic template, and adds the new scene to whichever folder is currently open in the project window.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8fc0301f8eb2
unity_docs
editor
Explain 'Create a custom Editor window with C# script' in Unity.
Version : 2022.3+ This example demonstrates how to create a custom Editor window with C# script to react to user input, make the UI resizable, and handle hot-reloading. A custom Editor window is a class that derives from the EditorWindow class. UI Toolkit uses the CreateGUI method to add controls to Editor UI, and Unit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_030560b468a3
unity_docs
performance
In Unity's 'Visual Studio project generation for Windows', what is 'Scripting backends' and how does it work?
Depending on which scripting backend your Unity project uses, the Visual Studio Solution that Unity generates includes a different number of projects. For the Mono scripting backend, the solution includes three projects. For the IL2CPP scripting backend, the solution includes four projects. Note : You can only build Wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49f9f35c1389
unity_docs
scripting
What is `DestroyGameObjectHierarchyEventArgs.ctor` in Unity? Explain its purpose and usage.
DestroyGameObjectHierarchyEventArgs Constructor Declaration public DestroyGameObjectHierarchyEventArgs (int instanceId , SceneManagement.Scene scene ); Declaration public DestroyGameObjectHierarchyEventArgs (int instanceId , int parentInstanceId , SceneManagement.Scene scene ); Parameters Parameter ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_74fd31749d91
unity_docs
scripting
What is `Events.UnityEvent.AddListener` in Unity? Explain its purpose and usage.
UnityEvent.AddListener Declaration public void AddListener ( Events.UnityAction call ); Parameters Parameter Description call Callback function. Description Adds a non-persistent listener to the UnityEvent. Adds a runtime callback. You can add many different listeners. If you add identical listeners mult...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7375de3ea7fc_doc_6
github
scripting
What does `EmbedPackage` do in this Unity script? Explain its purpose and signature.
Moves the desired package to the Packages folder. (This prevents the package from being read only) Signature: ```csharp public static void EmbedPackage(string packageName, Action<bool> success) ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_b752802aa16b
unity_docs
rendering
In Unity's 'Lighting configuration workflow', what is 'Fine-tune your scene lighting' and how does it work?
To fine-tune your scene lighting, follow these tasks based on project requirements: Add baked, realtime, or mixed lights . Optionally configure emissive surfaces with Baked GI or Realtime GI . Add baked, realtime, or custom Reflection Probes . If a GI mode is set, add Light Probes . You can also add Light Probe Proxy V...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f468cee83fcb
unity_docs
scripting
Show me a Unity C# example demonstrating `SystemLanguage.Hungarian`.
SystemLanguage.Hungarian Description Hungarian. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { //This checks if your computer's operating system is in the Hungarian language if (Application.systemLanguage == SystemLanguage.Hungarian) { //Outputs into console that the system ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b6db4530bd10
unity_docs
rendering
What is `TextureImporter.GetDefaultPlatformTextureSettings` in Unity? Explain its purpose and usage.
TextureImporter.GetDefaultPlatformTextureSettings Declaration public TextureImporterPlatformSettings GetDefaultPlatformTextureSettings (); Returns TextureImporterPlatformSettings A TextureImporterPlatformSettings structure containing the default platform parameters. Description Gets the default platfo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c0c93a28122c
unity_docs
xr
What is `Caching.IsVersionCached` in Unity? Explain its purpose and usage.
Caching.IsVersionCached Declaration public static bool IsVersionCached (string url , Hash128 hash ); Obsolete Please use IsVersionCached with Hash128 instead. Declaration public static bool IsVersionCached (string url , int version ); Parameters Parameter Description Url The filename of the Asset...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b6e3e36dcf01
unity_docs
scripting
What is `SerializationUtility.GetManagedReferencesWithMissingTypes` in Unity? Explain its purpose and usage.
SerializationUtility.GetManagedReferencesWithMissingTypes Declaration public static ManagedReferenceMissingType[] GetManagedReferencesWithMissingTypes ( Object obj ); Description Returns the list of managed references that could not be deserialized because of a missing type. This method returns the list of Ma...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_ad738f68e684
github
scripting
Write a Unity C# script called Color Property_Writeable
```csharp using UnityEngine; namespace LeakyAbstraction.ReactiveScriptables { [CreateAssetMenu(menuName = "Game Properties/Color Property - Writeable")] public class ColorProperty_Writeable : ColorProperty { new public void Set(Color value) => SetAndNotify(value); } } ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_630d392e1844
unity_docs
networking
What is `Networking.DownloadHandler.GetText` in Unity? Explain its purpose and usage.
DownloadHandler.GetText Declaration protected string GetText (); Returns string String to return as the return value of the text property. Description Callback, invoked when the text property is accessed. The return value of this method will be returned as the value of the data property. This method will ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1513223aada
unity_docs
editor
What are the parameters of `PrefabUtility.GetCorrespondingObjectFromSourceAtPath` in Unity?
Returns TObject The corresponding object or null. Description Retrieves the corresponding object of the given object from a given Prefab Asset path. Use this method to find the corresponding asset the source was instantiated from, if but only if it is within the prefab asset at the specified path. If you don't have the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4be2aae38f8e
unity_docs
scripting
Show me a Unity C# example demonstrating `Awaitable.MainThreadAsync`.
Awaitable.MainThreadAsync Declaration public static MainThreadAwaitable MainThreadAsync (); Returns MainThreadAwaitable Awaitable object that completes when switching to the main thread. Description Resumes execution on the Unity main thread. Completes immediately when called from the main thread. ```csha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_914cfbf17226
unity_docs
audio
In Unity's 'Audio file format compatibility', what is 'Supported audio file formats' and how does it work?
Unity supports mono, stereo, and multichannel audio assets up to eight channels. You can import the following audio file formats into Unity: Format Extensions MPEG layer 3.mp3 Audio Interchange File Format.aiff / .aif Microsoft Wave.wav Ogg Vorbis.ogg Free Lossless Audio Codec (FLAC).flac Unity also lets you import tra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_af59e5e73545_doc_1
github
scripting
What does `GetUnityClass` do in this Unity script? Explain its purpose and signature.
Converts this PlainMesh class into its Unity Mesh equivalent Signature: ```csharp public Mesh GetUnityClass() ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_a5fa1479f6c4
unity_docs
rendering
What are the parameters of `ImageConversion.EncodeNativeArrayToJPG` in Unity?
Description Encodes this native array into JPG format. This function returns a NativeArray<byte> which is the JPG data. You can store the encoded data as a file or send it over the network without further processing. This function does not work on any compressed format. The encoded JPG data will be ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f9106208c61
unity_docs
scripting
What is `Logger.LogFormat` in Unity? Explain its purpose and usage.
Logger.LogFormat Declaration public void LogFormat ( LogType logType , string format , params object[] args ); Declaration public void LogFormat ( LogType logType , Object context , string format , params object[] args ); Parameters Parameter Description logType The type of the log message. co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9ec0082ba2b
unity_docs
physics
What is `Rigidbody2D.GetShapes` in Unity? Explain its purpose and usage.
Rigidbody2D.GetShapes Declaration public int GetShapes ( PhysicsShapeGroup2D physicsShapeGroup ); Parameters Parameter Description physicsShapeGroup The PhysicsShapeGroup2D to store the retrieved PhysicsShape2D in. Returns int Returns the number of PhysicsShape2D retrieved from the Rigidbody2D . ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_abe6e345fbe9
unity_docs
performance
In Unity's 'Analyzing coroutines', what is 'Monitor and improve coroutine performance' and how does it work?
You can use the Unity Profiler to inspect and understand where Unity executes coroutines in your application. To do this, profile your application with Deep Profiling enabled, which profiles every part of your script code and records all function calls. You can then use the CPU Usage Profiler module to investigate the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_11e062186cc9
unity_docs
networking
What is `Networking.PlayerConnection.EditorConnection.RegisterConnection` in Unity? Explain its purpose and usage.
EditorConnection.RegisterConnection Declaration public void RegisterConnection (UnityAction<int> callback ); Parameters Parameter Description callback Action called when a new Player connects, with the Player ID of the Player. Description Registers a callback, executed when a new Player connects to the Edi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_94038ada3795
unity_docs
rendering
In Unity's 'Save and load lighting settings with Lightmap Parameters Assets', what is 'Scenes' and how does it work?
To assign a Lightmap Parameters Asset to the whole Scene: Open the Lighting window ( Window > Rendering > Lighting ) Click the Scene tab Navigate to the Lightingmapping Settings . Use the Lightmap Parameters drop-down to assign a default Lightmap Parameters Asset. This drop-down lists all available Lightmap Parameters ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4f7990b0092c
unity_docs
rendering
What is `SceneManagement.EditorSceneManager.GetSceneCullingMask` in Unity? Explain its purpose and usage.
EditorSceneManager.GetSceneCullingMask Declaration public static ulong GetSceneCullingMask ( SceneManagement.Scene scene ); Parameters Parameter Description scene The scene to get the culling mask from. Returns ulong The scene's current culling mask as a bitfield. Description Return the culling mask...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4113f0676312
unity_docs
scripting
Show me a Unity C# example demonstrating `Terrain.detailObjectDistance`.
Terrain.detailObjectDistance public float detailObjectDistance ; Description Detail objects will be displayed up to this distance. Additional resources: detailObjectDensity . ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { Terrain.activeTerrain.detailObjectDistance = 40; ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ba7d34055d3a
unity_docs
rendering
What is `ComputeShader.SetRayTracingAccelerationStructure` in Unity? Explain its purpose and usage.
ComputeShader.SetRayTracingAccelerationStructure Declaration public void SetRayTracingAccelerationStructure (int kernelIndex , int nameID , Rendering.RayTracingAccelerationStructure accelerationStructure ); Declaration public void SetRayTracingAccelerationStructure (int kernelIndex , string name , Rende...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78a53265bcbc
unity_docs
editor
What is `PlayerSettings.Android.enableArmv9SecurityFeatures` in Unity? Explain its purpose and usage.
PlayerSettings.Android.enableArmv9SecurityFeatures public static bool enableArmv9SecurityFeatures ; Description Enable Armv9 security features, including Pointer Authentication (PAuth, PAC) and Branch Target Identification (BTI) for Arm64 builds. ```csharp using UnityEngine; using UnityEditor; using UnityEdito...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_795bcd04f4d3
unity_docs
rendering
Give me an overview of the `CombineInstance` class in Unity.
CombineInstance struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Struct used to describe meshes to be combined using Mesh.CombineMeshes . Properties Property Description lightmapScaleOffset The baked lightmap UV scale and offset applied to the Mesh. mesh Mesh to combine. realti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e817c9384d2
unity_docs
math
What is `Experimental.Lightmapping.SetAdditionalBakedProbes` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Lightmapping.SetAdditionalBakedProbes Obsolete Please use UnityEngine.LightTransport.IProbeIntegrator instead. Declaration public static void SetAdditionalBakedProbes (int id , Vector3[] positions ); Obsolete Please use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7aa9ba72b4f5
unity_docs
editor
Give me an overview of the `HelpURLAttribute` class in Unity.
HelpURLAttribute class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Provide a custom documentation URL for a class. The provided URL is expected to be an absolute path. If no file is found at the URL, the path is resolved relative to the Unity documentation, which can be either the manual...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a1e2dc91ac8
unity_docs
editor
What is `Search.SearchIndexer.Start` in Unity? Explain its purpose and usage.
SearchIndexer.Start Declaration public void Start (bool clear ); Parameters Parameter Description clear True if the the current index should be cleared. Description Starts indexing entries. ```csharp using System.Linq; using UnityEditor; using UnityEditor.Search; using UnityEngine; /// <summary> /// Sear...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_900ac9c1cb2f
unity_docs
editor
What is `IMGUI.Controls.ArcHandle.angleHandleColor` in Unity? Explain its purpose and usage.
ArcHandle.angleHandleColor public Color angleHandleColor ; Description Returns or specifies the color of the angle control handle. This value is multiplied with the value of Handles.color at the time DrawHandle is called. If Color.a is 0 then the angle handle is disabled. Additional resources: angle...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b3b4aa33f1fa
unity_docs
scripting
What is `Handles.FreeMoveHandle` in Unity? Explain its purpose and usage.
Handles.FreeMoveHandle Declaration public static Vector3 FreeMoveHandle ( Vector3 position , float size , Vector3 snap , Handles.CapFunction capFunction ); Declaration public static Vector3 FreeMoveHandle (int controlID , Vector3 position , float size , Vector3 snap , Handles.CapFunction ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4908d9cea2f2
unity_docs
editor
Show me a Unity code example for 'Visualizing profiler counters'.
identify performance issues quickly. ## Adding metrics to your code The following example assumes that the GameManager class handles high level logic and knows about enemies. To update the value of the counter, in the Update or LateUpdate method (depending on when the logic is performed with spawning or destroying en...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8e94dfab4d80
unity_docs
rendering
What is `TrailRenderer.colorGradient` in Unity? Explain its purpose and usage.
TrailRenderer.colorGradient public Gradient colorGradient ; Description Set the color gradient describing the color of the trail at various points along its length. Additional resources: Gradient . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(TrailRenderer))] public class ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_85fd2c4b64a0
unity_docs
scripting
Show me a Unity C# example demonstrating `Event.type`.
Event.type public EventType type ; Description The type of event. Additional resources: EventType , GUI Scripting Guide . ```csharp using UnityEngine;public class Example : MonoBehaviour { // Prints the current event detected. void OnGUI() { Debug.Log("Current event detected: " + Event.current.type); ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c75516b2dfc7
unity_docs
math
Show me a Unity C# example demonstrating `Matrix4x4.Translate`.
Matrix4x4.Translate Declaration public static Matrix4x4 Translate ( Vector3 vector ); Description Creates a translation matrix. ```csharp // Translate, rotate and scale a mesh. Try varying // the parameters in the inspector while running // to see the effect they have.using UnityEngine; using System.Collect...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_784a8fdadf8b_doc_6
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Whether to determine streaming LOD based on distance, instead of altitude. Signature: ```csharp public bool StreamingLodBasedOnDistance ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_8937e4c3b390
unity_docs
scripting
What are the parameters of `ParticleSystem.Play` in Unity?
Description Starts the Particle System. Sets the Particle Systems into play mode and enables emitting (if it has been disabled). If the Particle System has been paused , then this resumes playing from the previous time. If the Particle System has stopped , then the system starts from time 0, and, if it is relevant, the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1de48bdb5cb7
unity_docs
rendering
In Unity's 'Branch based on Unity version', what is 'Unity 2023 or earlier' and how does it work?
Use the format YYYYMP , where: YYYY is the major version. M is the minor version. P is the patch version. For example, for Unity 2022.3.0, use 202230 . You can use only values up to 9 for the minor and patch versions. This means you can’t check for a Unity version with a minor version larger than 9 or a patch version l...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_aaa47d474116
unity_docs
xr
In Unity's 'Project manifest file', what is 'Setting a resolution strategy' and how does it work?
While you can force Unity’s package dependency resolution to use higher versions of indirect dependencies by adding them explicitly to the project manifest, this isn’t a good strategy, for two reasons: It puts more responsibility on the project owner to maintain dependency versions. Over time, you might have dependenci...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_883e62410393
unity_docs
editor
What is `SettingsProvider.GetSearchKeywordsFromSerializedObject` in Unity? Explain its purpose and usage.
SettingsProvider.GetSearchKeywordsFromSerializedObject Declaration public static IEnumerable<string> GetSearchKeywordsFromSerializedObject ( SerializedObject serializedObject ); Parameters Parameter Description serializedObject Object to extract properties from. Returns IEnumerable<string> Returns the l...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_25694a22976e
unity_docs
xr
What is `Rendering.AsyncGPUReadback.RequestIntoNativeSliceAsync` in Unity? Explain its purpose and usage.
AsyncGPUReadback.RequestIntoNativeSliceAsync Declaration public static Awaitable<AsyncGPUReadbackRequest> RequestIntoNativeSliceAsync (ref NativeSlice<T> output , Texture src , int mipIndex ); Declaration public static Awaitable<AsyncGPUReadbackRequest> RequestIntoNativeSliceAsync (ref NativeSlice<T> outpu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_42687e3f2df6
unity_docs
scripting
What is `MPE.EventDataSerialization` in Unity? Explain its purpose and usage.
EventDataSerialization enumeration Description The Serialization type for sending a message, with arguments, using the EventService . For more information about argument serialization, see ChannelService.Broadcast and ChannelService.Emit. Properties Property Description StandardJson Use normal JSON to send a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b72753d539f6
unity_docs
scripting
What is `SystemLanguage.Basque` in Unity? Explain its purpose and usage.
SystemLanguage.Basque Description Basque. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { //This checks if your computer's operating system is in the Basque language if (Application.systemLanguage == SystemLanguage.Basque) { //Outputs into console that the system is Basque D...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb0a5f2360c2
unity_docs
physics
What is `AI.NavMeshBuildSource.component` in Unity? Explain its purpose and usage.
NavMeshBuildSource.component public Component component ; Description Points to the owning component - if available, otherwise null. When build sources are obtained using NavMeshBuilder.CollectSources , this value typically refers to a mesh or collider component - however for shared meshes it will be null. A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_97ddfe2452a0
unity_docs
scripting
What is `ParticleSystem.CollisionModule.maxCollisionShapes` in Unity? Explain its purpose and usage.
ParticleSystem.CollisionModule.maxCollisionShapes public int maxCollisionShapes ; Description The maximum number of collision shapes Unity considers for particle collisions. It ignores excess shapes. Terrains take priority. Additional resources: ParticleSystem.collision . ```csharp using UnityEngine; using S...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9d6f8a3e10fd
unity_docs
editor
What is `AssetImporters.AssetImporterEditor.extraDataSerializedObject` in Unity? Explain its purpose and usage.
AssetImporterEditor.extraDataSerializedObject protected ExtraDataSerializedObject extraDataSerializedObject ; Description A SerializedObject that represents the extraDataTarget or the extraDataTargets of the AssetImporterEditor . See extraDataType and the example in AssetImporterEditor class for more...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e4e884a87630
unity_docs
scripting
Show me a Unity C# example demonstrating `TextAsset.text`.
Supported encodings are: UTF-32 Big or Little Endian with a byte order mark, UTF-16 Big or Little Endian with a byte order mark, UTF-8 with a byte order mark, UTF-8 without a byte order mark. This encoding is used as a fallback, if the above encodings can't decode the file without missing characters. To use a spec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_77d4fb507c00
unity_docs
editor
What is `AssetBundleBuild.assetNames` in Unity? Explain its purpose and usage.
AssetBundleBuild.assetNames public string[] assetNames ; Description Asset names which belong to the given AssetBundle. Please use the asset path relative to the project folder, for example "Assets/MyPrefab.prefab". An AssetBundle can contain either Scene files or Asset files, but not a mix of the two. This sam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c32682468cd8
unity_docs
rendering
What is `Rendering.ShadowSplitData.cullingSphere` in Unity? Explain its purpose and usage.
ShadowSplitData.cullingSphere public Vector4 cullingSphere ; Description The culling sphere. The first three components of the vector describe the sphere center, and the last component specifies the radius.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_07a76269ae5e
unity_docs
rendering
What is `TextureFormat.RGBA64` in Unity? Explain its purpose and usage.
TextureFormat.RGBA64 Description Four channel (RGBA) texture format, 16-bits unsigned integer per channel. Note that not all graphics cards support all texture formats, use SystemInfo.SupportsTextureFormat to check. Additional resources: Texture2D.format , texture assets .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8763d994dc5e
unity_docs
scripting
What is `Rendering.BatchDrawCommandProceduralIndirect.visibleInstancesBufferWindowSizeBytes` in Unity? Explain its purpose and usage.
BatchDrawCommandProceduralIndirect.visibleInstancesBufferWindowSizeBytes public uint visibleInstancesBufferWindowSizeBytes ; Description Amount of data in the buffer to be bound, starting from the visibleInstancesBufferWindowOffset value.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7717c1f69c76
unity_docs
scripting
What is `TagHandle.GetExistingTag` in Unity? Explain its purpose and usage.
TagHandle.GetExistingTag Declaration public static TagHandle GetExistingTag (string tagName ); Parameters Parameter Description tagName The name of the tag to get a handle to. Returns TagHandle A new TagHandle for the existing tag. Description Get a handle to a existing defined tag. This method ca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_029a5de84f03
unity_docs
rendering
What is `Shader.SetGlobalVectorArray` in Unity? Explain its purpose and usage.
Shader.SetGlobalVectorArray Declaration public static void SetGlobalVectorArray (string name , Vector4[] values ); Declaration public static void SetGlobalVectorArray (int nameID , Vector4[] values ); Declaration public static void SetGlobalVectorArray (string name , List<Vector4> values ); Declara...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e0d8e02b81ed
unity_docs
performance
What is `Android.AndroidGameMode` in Unity? Explain its purpose and usage.
AndroidGameMode enumeration Description Options for the available game modes that AndroidGame.GameMode can return. Properties Property Description Unsupported Game mode is not supported. For more information, refer to getGameMode. Standard Standard game mode, which indicates that your application should us...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a3e3d0eb1df7
unity_docs
rendering
What is `SpriteRenderer.drawMode` in Unity? Explain its purpose and usage.
SpriteRenderer.drawMode public SpriteDrawMode drawMode ; Description The current draw mode of the Sprite Renderer. When the drawMode is set to SpriteDrawMode.Sliced or SpriteDrawMode.Tiled , the SpriteRenderer will render the sprite as a 9-slice image. A 9-Slice image is where an image is divided int...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c6181559bcb7
unity_docs
xr
What is `Rendering.BatchCullingViewType.Filtering` in Unity? Explain its purpose and usage.
BatchCullingViewType.Filtering Description The Scene view is requesting culling so that it can render filtered objects. Unity calls the OnPerformCulling() with this enum value when a user writes a search query in the Hierarchy window.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a06ff30d68d5
unity_docs
scripting
Show me a Unity C# example demonstrating `SerializedProperty.exposedReferenceValue`.
SerializedProperty.exposedReferenceValue public Object exposedReferenceValue ; Description A reference to another Object in the Scene. This reference is resolved in the context of the SerializedObject containing the SerializedProperty. Additional resources: ExposedReference<T0> , SerializedPropertyType.Expose...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_df3b0ef39fad
unity_docs
scripting
What is `UIElements.DataBinding.sourceToUiConverters` in Unity? Explain its purpose and usage.
DataBinding.sourceToUiConverters public UIElements.ConverterGroup sourceToUiConverters ; Description Returns the ConverterGroup used when trying to convert data from the data source to a UI property.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a1fb6810282
unity_docs
scripting
What is `GUISkin.horizontalScrollbar` in Unity? Explain its purpose and usage.
GUISkin.horizontalScrollbar public GUIStyle horizontalScrollbar ; Description Style used by default for the background part of GUI.HorizontalScrollbar controls. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Modifies only the default background of the // horizontal scrollbar of the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_990403b1b833
unity_docs
scripting
What is `UIElements.StylePropertyName.operator_eq` in Unity? Explain its purpose and usage.
StylePropertyName.operator == public static bool operator == ( UIElements.StylePropertyName lhs , UIElements.StylePropertyName rhs ); Parameters Parameter Description lhs First StylePropertyName. rhs Second StylePropertyName. Returns bool True if both StylePropertyNames are equal. False otherwise. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4f8109ff41e8
unity_docs
physics
What is `ArticulationBody.AddForceAtPosition` in Unity? Explain its purpose and usage.
ArticulationBody.AddForceAtPosition Declaration public void AddForceAtPosition ( Vector3 force , Vector3 position , ForceMode mode = ForceMode.Force); Parameters Parameter Description force The force vector in world coordinates. position A position in world coordinates. mode The type of force to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_3619a2f53add_doc_1
github
scripting
What does `Start` do in this Unity script? Explain its purpose and signature.
Callback when the TintTextureGenerator is loaded.Refreshes the Grid Component on this GameObject. Signature: ```csharp public void Start() ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_67c8546b44a9
unity_docs
ui
What is `EditorGUILayout.MinMaxSlider` in Unity? Explain its purpose and usage.
EditorGUILayout.MinMaxSlider Declaration public static void MinMaxSlider (ref float minValue , ref float maxValue , float minLimit , float maxLimit , params GUILayoutOption[] options ); Declaration public static void MinMaxSlider (string label , ref float minValue , ref float maxValue , float minLimit ,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4d1d52ea8595
unity_docs
scripting
Explain 'AssetBundle file format reference' in Unity.
When you use BuildPipeline.BuildAssetBundles to build AssetBundles , Unity writes the following files to a specified output directory: The AssetBundle files . A.manifest file for each AssetBundle file . A manifest bundle . Note: If you use the Addressables package to build AssetBundles, it produces an AssetBundle file ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1f7636cdad89
unity_docs
rendering
Show me a Unity code example for 'Create a Movie Texture'.
f ). When you add a video file to your Project, Unity automatically imports it and converts it to Ogg Theora format. Once Unity has imported your Movie Texture, you can attach it to any GameObject or Material in the same way as a regular Texture. ## Playing the Movie Your Movie Texture will not play automatically whe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3302b21833f0
unity_docs
input
What is `Input.GetKey` in Unity? Explain its purpose and usage.
Input.GetKey Declaration public static bool GetKey (string name ); Description Returns true while the user holds down the key identified by name . Note : This API is part of the legacy Input Manager. The recommended best practice is that you don't use this API in new projects. For new projects, use the Input ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.