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_1e0f3dc63664
unity_docs
rendering
What is `Renderer.rayTracingMode` in Unity? Explain its purpose and usage.
Renderer.rayTracingMode public Experimental.Rendering.RayTracingMode rayTracingMode ; Description Describes how this renderer is updated for ray tracing. Additional resources: RayTracingMode .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5f20861c86e6
unity_docs
editor
What is `iOS.Xcode.PBXProject.AddHeadersBuildPhase` in Unity? Explain its purpose and usage.
PBXProject.AddHeadersBuildPhase Declaration public string AddHeadersBuildPhase (string targetGuid ); Parameters Parameter Description targetGuid The GUID of the target, such as the one returned by TargetGuidByName . Returns string Returns the GUID of the new phase. Description Creates a new headers ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9e8634c29cb9
unity_docs
xr
Explain 'Choose and configure XR provider plug-ins' in Unity.
Use the XR Plug-in Management settings to choose and configure XR provider plug-ins. Provider plug-ins are packages created to support XR devices and platforms. Use the XR Plug-in Management settings to manage which XR devices and platforms your project supports. You can also configure important settings for these XR p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_77b360782c6a
unity_docs
editor
What are the parameters of `VersionControl.Provider.LockIsValid` in Unity?
Description Returns true if the Provider.Lock task can be executed on one or more assets from the given asset list. ```csharp using System.Collections.Generic; using UnityEditor; using UnityEditor.VersionControl; using UnityEngine;public class EditorScript : MonoBehaviour { [MenuItem("Version Control/LockIsValid")]...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a42bd464b256
unity_docs
rendering
What is `TerrainTools.PaintContext.kNormalizedHeightScale` in Unity? Explain its purpose and usage.
PaintContext.kNormalizedHeightScale public static float kNormalizedHeightScale ; Description Unity uses this value internally to transform a [0, 1] height value to a texel value, which is stored in TerrainData.heightmapTexture .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e21816c52172
unity_docs
scripting
Show me a Unity C# example demonstrating `Color.operator_divide`.
Color.operator / public static Color operator / ( Color a , float b ); Description Divides color a by the float b . Each color component is scaled separately. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { Color grayColor = Color.white / 2; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_52d885e614cc
unity_docs
scripting
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerSummaryMetrics.NumberOfCachedReads` in Unity? Explain its purpose and usage.
AsyncReadManagerSummaryMetrics.NumberOfCachedReads public int NumberOfCachedReads ; Description The total number of cached reads (so read time was zero) in the metrics included in the summary calculation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d3fe9552f0ed
unity_docs
rendering
In Unity's 'Upgrade material assets to URP or HDRP', what is 'Upgrade BiRP materials to HDRP' and how does it work?
To upgrade all material assets from BiRP to HDRP: Back up your Built-in Render Pipeline material assets. In your HDRP project, go to Edit > Rendering > Materials > Convert All Built-in Materials to HDRP . To upgrade only some material assets from BiRP to HDRP: Back up your Built-in Render Pipeline material assets. In y...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d4d176d1ff16
unity_docs
scripting
Show me a Unity C# example demonstrating `RectTransform.rect`.
RectTransform.rect public Rect rect ; Description The calculated rectangle in the local space of the Transform . Unity automatically attaches these to UI elements. Manipulate aspects of the rectangle in the Inspector such as the position, dimensions, rotation, and scale. This is read-only in a script. ```cs...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ee9abc00dd8
unity_docs
scripting
What is `LightTransport.RadeonRaysContext.WriteBuffer` in Unity? Explain its purpose and usage.
RadeonRaysContext.WriteBuffer Declaration public void WriteBuffer (BufferSlice<T> dst , NativeArray<T> src ); Declaration public void WriteBuffer (BufferSlice<T> dst , NativeArray<T> src , LightTransport.EventID id ); Parameters Parameter Description dst The buffer slice to write to. src The arra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a43d9ae74275
unity_docs
rendering
What is `Rendering.SinglePassStereoMode.Instancing` in Unity? Explain its purpose and usage.
SinglePassStereoMode.Instancing Description Render stereo using GPU instancing. In instanced single-pass stereo rendering, the rendering pipeline traverses the scene graph only once and issues a single, instanced draw call for each render node, thus reducing the bandwidth required to render the scene. Scene cullin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ef26a836aabd
unity_docs
rendering
Show me a Unity C# example demonstrating `DynamicGI.SetEnvironmentData`.
time Global Illumination, without changing the Skybox Material. The input array represents a cube with each face being 8 x 8 texels and each texel being 4 floats (for the RGBA values of the texel's color), so the size of the array is 8*8*6*4 = 1536 floats. Note that changing the Distant Environment Lighting Source or ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_078101e1e91a
unity_docs
rendering
What is `Rendering.PassIdentifier.ctor` in Unity? Explain its purpose and usage.
PassIdentifier Constructor Declaration public PassIdentifier (uint subshaderIndex , uint passIndex ); Parameters Parameter Description subshaderIndex The index of the SubShader the Pass belongs to. passIndex The index of the Pass in the SubShader. Description Constructs a new PassIdentifier with the giv...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_86ed0ba6d748
unity_docs
physics
In Unity's 'CPU Usage Profiler module reference', what is 'Chart categories' and how does it work?
The CPU Usage Profiler module’s chart tracks the time spent on the application’s main thread. Chart Description Rendering How much time your application spends on rendering graphics. Scripts How much time your application spends on running scripts. Physics How much time your application spends on the physics system. An...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_17ac15443d95
unity_docs
scripting
Explain 'Define a data source for runtime binding' in Unity.
When you create a binding object, you must define a data source. The data source is the object that contains the property you want to bind to. You can use any C# object as the runtime binding data source. To enable the binding system to access the data source, you must define the dataSource property of the binding obje...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_56df62c0fa04
unity_docs
scripting
In Unity's 'Stop and restart Unity Accelerator', what is 'Linux' and how does it work?
Use the systemctl console utility to control the unity-accelerator service. For more information, refer to https://manpages.ubuntu.com/manpages/bionic/en/man1/systemctl.1.html . Examples: ``` $ sudo systemctl stop unity-accelerator.service # Stops the service $ sudo systemctl start unity-accelerator.service # Starts th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7ef3c2fb1281
unity_docs
rendering
In Unity's 'Material Validator window reference for the Built-In Render Pipeline', what is 'Validate Metal Specular mode' and how does it work?
The PBR Validation Settings that appear in the Scene view when you set Material Validation to Validate Metal Specular . Property Description Check Pure Metals Enable this checkbox if you want the Material Validator to highlight in yellow any pixels it finds which Unity defines as metallic, but which have a non-zero alb...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_19906f2f5b49
unity_docs
editor
In Unity's 'Additional IL2CPP compiler arguments', what is 'Check if arguments are set' and how does it work?
If your project has additional IL2CPP arguments set, then compiling for more than one platform might not work as expected, especially when cross-compiling for Linux . To check if any additional IL2CPP arguments are already set, do one of the following: Check if the environment variable IL2CPP_ADDITIONAL_ARGS is set. In...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2df5ce8d21f1
unity_docs
scripting
In Unity's 'Transition events', what is 'Behavior' and how does it work?
Each transition property has its own lifecycle and its own transition events. You can access the current property with an event’s stylePropertyNames property. If a shorthand USS property is changed, every component also gets its own lifecycle. For example, if you change margin , margin-left , margin-right , margin-top ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3cbed258452c
unity_docs
scripting
What is `Search.ISearchView.SetColumns` in Unity? Explain its purpose and usage.
ISearchView.SetColumns Declaration public void SetColumns (IEnumerable<SearchColumn> columns ); Parameters Parameter Description columns Columns to be set in the search view table configuration used in DisplayMode.Table . Description Sets the search view property table columns.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_094ad1484254
unity_docs
rendering
What is `SpeedTree.Importer.SpeedTree9Importer.OnCustomEditorSettings` in Unity? Explain its purpose and usage.
SpeedTree9Importer.OnCustomEditorSettings(ref SerializedProperty, ref SerializedProperty) Parameters Parameter Description diffusionProfileAsset A reference to the SerializedProperty representing the Diffuse Profile asset. diffusionProfileHash A reference to the SerializedProperty representing the Diffuse Profi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_18c80a317983_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A base class for MonoBehaviours that can beinstantiatedor addedto a with four arguments passed to the function of the created instance.Instances of classes inheriting from receive the arguments via the method where they can be assigned to member fields or properties. Type of the first argument received in the funct...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_4d4d02f12192
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUILayout.BeginBuildTargetSelectionGrouping`.
EditorGUILayout.BeginBuildTargetSelectionGrouping Declaration public static BuildTargetGroup BeginBuildTargetSelectionGrouping (); Description Begin a build target grouping and get the selected BuildTargetGroup back. Build Target Selection Group ```csharp using UnityEditor;public class BuildTargetGroupExampl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_32d5964aed67
unity_docs
rendering
Explain 'Work with multiple scenes in Unity' in Unity.
If you need to create large streaming worlds or want to effectively manage multiple scenes at runtime, you can open and edit multiple scenes in the Unity Editor simultaneously. Having multiple scenes open at once also lets you improve the workflow, especially if you often have to edit scenes collaboratively. Topic Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ce4b90a69221
unity_docs
scripting
Explain 'Call and implement native UWP plug-ins' in Unity.
To call and implement native Universal Windows Platform (UWP) plug-ins , you need to know how to create native plug-ins for Unity. For more information about native plug-ins and their uses, refer to Native plug-ins . IL2CPP scripting backend supports the P/Invoke mechanism for native plug-ins. This means that you can c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9959b1f21fa0
unity_docs
math
Show me a Unity C# example demonstrating `Mathf.Ceil`.
Mathf.Ceil Declaration public static float Ceil (float f ); Description Returns the smallest integer greater than or equal to f . ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Example() { // Prints 10 Debug.Log(Mathf.Ceil(10.0F)); // Prints 11 De...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9386c53cdd89
unity_docs
physics
What is `ConfigurableJoint` in Unity? Explain its purpose and usage.
ConfigurableJoint class in UnityEngine / Inherits from: Joint / Implemented in: UnityEngine.PhysicsModule Description The configurable joint is an extremely flexible joint giving you complete control over rotation and linear motion. You can build all other joints with it and much more but it is also more com...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2346e7c64a5
unity_docs
scripting
What is `SceneManagement.SceneUtility.GetScenePathByBuildIndex` in Unity? Explain its purpose and usage.
SceneUtility.GetScenePathByBuildIndex Declaration public static string GetScenePathByBuildIndex (int buildIndex ); Returns string Scene path (e.g "Assets/Scenes/Scene1.unity"). Description Get the Scene path from a build index. The build index refers to the index into the list of Scenes as specified in t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2cfac2d843e7
unity_docs
editor
In Unity's 'Memory Manager API for low-level native plug-ins', what is 'Track memory use in Unity' and how does it work?
To track your plug-in’s memory usage, use the Memory Profiler package to take a snapshot, then open the snapshot in the All Of Memory tab . When you use the IUnityMemoryManager to allocate memory, the Memory Profiler displays the plug-in’s memory allocations under the area and object name you assigned when you created ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db5ffbae0732
unity_docs
scripting
What is `UIElements.CollectionViewController.RaiseItemIndexChanged` in Unity? Explain its purpose and usage.
CollectionViewController.RaiseItemIndexChanged Declaration protected void RaiseItemIndexChanged (int srcIndex , int dstIndex ); Parameters Parameter Description srcIndex The source index. dstIndex The destination index. Description Invokes the itemIndexChanged event.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cf1bea89a1f3
unity_docs
rendering
Explain 'Run a compute shader' in Unity.
In your script, define a variable of ComputeShader type and assign a reference to the Asset. This allows you to invoke them with ComputeShader.Dispatch function. See Unity documentation on ComputeShader class for more details. Closely related to compute shaders is a ComputeBuffer class, which defines arbitrary data buf...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_64edfa7d3369
unity_docs
rendering
What is `ShaderUtil.GetShaderData` in Unity? Explain its purpose and usage.
ShaderUtil.GetShaderData Declaration public static ShaderData GetShaderData ( Shader shader ); Parameters Parameter Description shader The shader to get data from. Returns ShaderData The shader data for the provided shader. Description Get the shader data for a specific shader.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_68cccab21908
unity_docs
performance
Give me an overview of the `Il2CppCompilerConfiguration` class in Unity.
Il2CppCompilerConfiguration enumeration Description C++ compiler configuration used when compiling IL2CPP generated code. Properties Property Description Debug Debug configuration turns off all optimizations, which makes the code quicker to build but slower to run. Release Release configuration enables optimiz...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_acdbef67952f
unity_docs
physics
What is `Physics.DefaultRaycastLayers` in Unity? Explain its purpose and usage.
Physics.DefaultRaycastLayers public static int DefaultRaycastLayers ; Description Layer mask constant to select default raycast layers. This can be used in the layermask field of Physics.Raycast and other methods to select the default raycast layers. The default layers are all layers except for the ignore ra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_853bcdebddf6
unity_docs
rendering
What is `Debug.LogException` in Unity? Explain its purpose and usage.
Debug.LogException Declaration public static void LogException (Exception exception ); Declaration public static void LogException (Exception exception , Object context ); Parameters Parameter Description context Object to which the message applies. exception Runtime Exception. Description A var...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49ca20b82ee6
unity_docs
audio
What is `Video.VideoAudioOutputMode.APIOnly` in Unity? Explain its purpose and usage.
VideoAudioOutputMode.APIOnly Description Send the embedded audio to the associated AudioSampleProvider . Use this setting if you want to use Unity scripting to alter the video’s raw audio data. This is useful if you want direct, low-level control over the audio, or to analyse the data. Since the audio data goes t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_998a9d14477c
unity_docs
editor
What is `Search.StringView` in Unity? Explain its purpose and usage.
StringView struct in UnityEditor.Search Description Structure that holds a view on a string, with a specified range of [startIndex, endIndex[. A StringView contains only a reference to the original string, a start and an end index. It can be used to quickly create substrings or do any other operations that woul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c16ae41b2df
unity_docs
math
What is `Compilation.CompilationPipeline.ParseResponseFile` in Unity? Explain its purpose and usage.
CompilationPipeline.ParseResponseFile Declaration public static Compilation.ResponseFileData ParseResponseFile (string relativePath , string projectDirectory , string[] systemReferenceDirectories ); Parameters Parameter Description relativePath The path to the response file to be parsed. projectDirector...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_80662f89b5b0
unity_docs
ui
In Unity's 'ListView', what is 'Create a ListView' and how does it work?
You can create a ListView with UI Builder, UXML, and C#. The following C# example creates a ListView: ``` var listView = new ListView(); ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ed7cbaa92685
unity_docs
rendering
What is `ImageConversion.EnableLegacyPngGammaRuntimeLoadBehavior` in Unity? Explain its purpose and usage.
ImageConversion.EnableLegacyPngGammaRuntimeLoadBehavior public static bool EnableLegacyPngGammaRuntimeLoadBehavior ; Description Enables legacy PNG runtime import behavior. In previous versions of Unity, texture data from all PNG textures containing a gAMA block was returned in gamma 2.0 space. If you want to r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b0d1f608e745
unity_docs
math
Explain 'Optimize your Web build with WebAssembly 2023' in Unity.
The WebAssembly 2023 target contains features that can improve code performance, reduce generated code size, and reduce download times for your Web build on all supported browsers and platforms. If you enable the WebAssembly 2023 target, it automatically enables all of the following optimization features: Section Descr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bb7086c8636d
unity_docs
scripting
In Unity's 'Create trees and leaves from meshes', what is 'Use a mesh for the leaves' and how does it work?
You can use the leaf group’s mesh geometry mode to use an imported mesh. It can be flowers, fruit, or any other object you want to attach to the tree. Note that the mesh’s transform must be 0,0,0 . Any other transform is added as a distance from the tree, so the object floats by the tree instead of being attached to th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_543c81ec3b2d
unity_docs
scripting
What is `Handles.ConeHandleCap` in Unity? Explain its purpose and usage.
Handles.ConeHandleCap Declaration public static void ConeHandleCap (int controlID , Vector3 position , Quaternion rotation , float size , EventType eventType ); Parameters Parameter Description controlID The control ID for the handle. position The position of the handle in the space of Handles.m...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bd75f8823ffe
unity_docs
ui
What is `EditorGUI.LargeSplitButtonWithDropdownList` in Unity? Explain its purpose and usage.
EditorGUI.LargeSplitButtonWithDropdownList Declaration public static bool LargeSplitButtonWithDropdownList ( GUIContent content , string[] buttonNames , GenericMenu.MenuFunction2 callback , bool disableMainButton ); Parameters Parameter Description content Text, image and tooltip the button displays. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f892dfa2963
unity_docs
scripting
What is `VideoDeinterlaceMode` in Unity? Explain its purpose and usage.
VideoDeinterlaceMode enumeration Description Describes how the fields in the image, if any, should be interpreted. Properties Property Description Off Clip is not interlaced. Even First field is in the even lines. Odd First field is in the odd lines.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7fddf2528fdd
unity_docs
rendering
What is `Rendering.BatchCullingViewType` in Unity? Explain its purpose and usage.
BatchCullingViewType enumeration Description The type of an object that is requesting culling. Properties Property Description Unknown The type of the object that is requesting culling is unknown. Camera A Camera is requesting culling. Light A shadow-casting Light is requesting culling. Picking The Scene vie...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b8519ee4e276
unity_docs
rendering
What is `Rendering.CopyTextureSupport.TextureToRT` in Unity? Explain its purpose and usage.
CopyTextureSupport.TextureToRT Description Support for Texture to RenderTexture copies in Graphics.CopyTexture . Not all platforms can copy from a Texture2D into a RenderTexture directly. For example, Direct3D9 currently can not do this. See CopyTextureSupport for an overview.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8dd912adc9f7
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.StartAssetEditing`.
s is useful if you want to perform actions via script that make multiple changes to assets without the Asset Database importing each change in a separate import process. Instead, you can pause imports, make multiple changes, then resume imports, which means Unity only performs one input process for all the changes you...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_62f81b88e934
unity_docs
scripting
What is `Accessibility.VisionUtility` in Unity? Explain its purpose and usage.
VisionUtility class in UnityEngine.Accessibility / Implemented in: UnityEngine.AccessibilityModule Description A class containing methods to assist with accessibility for users with different vision capabilities. Static Methods Method Description GetColorBlindSafePalette Gets a palette of colors that should ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a8a96e91ccba
unity_docs
editor
In Unity's 'Use the Animation view', what is 'The Animated Properties list' and how does it work?
In the image below, the Animation view (left) shows the Animation used by the currently selected GameObject, and its child GameObjects if they are also controlled by this Animation. The Scene view and Hierarchy view are on the right, demonstrating that the Animation view shows the Animations attached to the currently s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55d112add452
unity_docs
editor
Show me a Unity C# example demonstrating `Unity.Profiling.Editor.ProfilerModule`.
for your own systems in the Profiler window. To define a ProfilerModule derived type, use an Editor script inside your project or package and attribute it with the ProfilerModuleMetadataAttribute . At a minimum, you must define the Profiler module’s name and chart counters, as shown below. The Profiler window auto...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3c9010c765f8
unity_docs
scripting
In Unity's 'Submit a UPM package for approval', what is 'Submit a UPM package to the Publisher Portal' and how does it work?
Open the Publisher Portal and select Products . In the Package tab, choose your package configuration and set a namespace. To learn more, refer to Create a Publisher Portal draft . In the Product information tab, add detailed information about the product, and any tags. In the Media tab, add videos, marketing images, a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_efbda95f51b4
unity_docs
xr
In Unity's 'Set up your 3D panoramic video', what is 'Set up your non–360° 3D panoramic video' and how does it work?
For non–360° 3D panoramic videos, a skybox material isn’t recommended. Follow these steps instead: Click on your panoramic video’s Video Player GameObject . In the Inspector window, set Render Mode to either Camera Near Plane or Camera Far Plane . Set 3D Layout to the layout of your panoramic video. For more informatio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1b6f4a4b3ce6
unity_docs
xr
What is `Networking.UnityWebRequest.GetTexture` in Unity? Explain its purpose and usage.
Removed UnityWebRequest.GetTexture Obsolete UnityWebRequest.GetTexture is obsolete. Use UnityWebRequestTexture.GetTexture instead. Upgrade to GetTexture Declaration public static Networking.UnityWebRequest GetTexture (string uri ); Obsolete UnityWebRequest.GetTexture is obsolete. Use UnityWebRequestText...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_87cba3f1c458
unity_docs
editor
Show me a Unity C# example demonstrating `VersionControl.Provider.Status`.
on for. asset The asset to fetch state information for. recursively If any assets specified are folders this flag will get status for all descendants of the folder as well. Description Starts a task that will fetch the most recent status about the asset or assets from the revision control system. The updated ass...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_62d71d91f290
unity_docs
scripting
What is `Experimental.GraphView.GraphView.GetBlackboard` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphView.GetBlackboard Declaration public Experimental.GraphView.Blackboard GetBlackboard (); Returns Blackboard Returns the associated blackboard. Returns null if the GraphView is not associated with a blackboard. De...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c6944b53076
unity_docs
rendering
What is `Canvas.planeDistance` in Unity? Explain its purpose and usage.
Canvas.planeDistance public float planeDistance ; Description How far away from the camera is the Canvas generated? It only applies when Canvas.renderMode is set to RenderMode.ScreenSpaceCamera .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ec40adf66611
unity_docs
audio
What is `Experimental.Audio.AudioSampleProvider.owner` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. AudioSampleProvider.owner public Object owner ; Description Object where this provider came from. E.g.: for AudioSampleProvider s that were obtained from a VideoPlayer , this will be the video player.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_982aceaf5334
unity_docs
ui
What is `UIElements.DefaultTreeViewController_1` in Unity? Explain its purpose and usage.
DefaultTreeViewController<T0> class in UnityEngine.UIElements / Inherits from: UIElements.TreeViewController / Implemented in: UnityEngine.UIElementsModule Description Default implementation of a TreeViewController . Public Methods Method Description AddItem Adds an item to the tree. GetDataForId ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_edb619fc6819
unity_docs
rendering
What is `ParticleSystem.ShapeModule.useMeshColors` in Unity? Explain its purpose and usage.
ParticleSystem.ShapeModule.useMeshColors public bool useMeshColors ; Description Modulate the particle colors with the vertex colors, or the Material color if no vertex colors exist. Additional resources: ParticleSystem.ShapeModule.shapeType .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a9368603b301
github
scripting
Write a Unity C# MonoBehaviour script called Event Link
```csharp using Hudossay.AttributeEvents.Assets.Runtime.GameEvents; using System; using UnityEngine; namespace Hudossay.AttributeEvents.Assets.Runtime.EventLinks { /// <summary> /// Links one event from broadcaster GameObject to one method from listener GameObject's MoonoBehaviour. /// </summary> publi...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_b2387a68be89
unity_docs
physics
What is `Collider2D.localToWorldMatrix` in Unity? Explain its purpose and usage.
Collider2D.localToWorldMatrix public Matrix4x4 localToWorldMatrix ; Description The transformation matrix used to transform the Collider physics shapes to world space. The Collider2D creates PhysicsShape2D in the space of any attached Rigidbody2D . The transformation matrix returned here transforms these...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_78b6e396b0c4
unity_docs
rendering
Explain 'Performance consideration for runtime UI' in Unity.
This section describes how you can improve the performance for runtime UI. Topic Description Use usage hints to reduce draw calls and geometry regeneration Use usage hints to set how an element is used at runtime. Usage hints can reduce draw calls and avoid geometry regeneration. Control textures of the dynamic atlas U...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1b2de35ff74a
unity_docs
rendering
What is `Camera.GetCommandBuffers` in Unity? Explain its purpose and usage.
Camera.GetCommandBuffers Declaration public CommandBuffer[] GetCommandBuffers ( Rendering.CameraEvent evt ); Parameters Parameter Description evt When to execute the command buffer during rendering. Returns CommandBuffer[] Array of command buffers. Description Get command buffers to be executed at ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c0d370d5f244
unity_docs
scripting
Show me a Unity C# example demonstrating `Search.SearchUtils.GetTransformPath`.
SearchUtils.GetTransformPath Declaration public static string GetTransformPath ( Transform tform ); Parameters Parameter Description tform Transform to extract name from. Returns string Returns a transform name using "/" as hierarchy separator. Description Format the pretty name of a Transform compo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7717991f660f
unity_docs
performance
Give me an overview of the `MeshOptimizationFlags` class in Unity.
MeshOptimizationFlags enumeration Description Options to control the optimization of mesh data during asset import. Properties Property Description PolygonOrder Optimize the order of polygons in the mesh to make better use of the GPUs internal caches to improve rendering performance. VertexOrder Optimize the o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0aa08706594a
unity_docs
editor
What are the parameters of `AssetDatabase.importPackageFailed` in Unity?
Description Callback raised whenever a package import failed. Includes an error message to give a reason for the failure. ```csharp using UnityEditor; using UnityEngine;[InitializeOnLoad] public class AssetDatabaseExamples { static AssetDatabaseExamples() { AssetDatabase.importPackageStarted += OnImport...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_221713f444a3_doc_5
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Destroys the given GameObject if it is not null, then creates a clone of the given TComponent and assigns it to the reference.IHierarchyBehaviour's will be initialized.Can be null, if it is not then it will be destroyed.The GameObject to clone.The TArgs object to be passed in on initialization.The type of arguments to ...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
gh_5ae8411512b0
github
scripting
Write a Unity C# MonoBehaviour script called Test Hierarchy Behaviour
```csharp using UnityEngine; namespace Duck.HierarchyBehaviour.Tests.Behaviours { [AddComponentMenu("")] public class TestHierarchyBehaviour : MonoBehaviour, IHierarchyBehaviour { public bool DidInitialize { get; private set; } public void Initialize() { DidInitialize = true; } } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_643728a381aa
unity_docs
rendering
What is `LightType` in Unity? Explain its purpose and usage.
LightType enumeration Description The type of a Light . Additional resources: Light.type , light component . Properties Property Description Spot The light is a cone-shaped spot light. Directional The light is a directional light. Point The light is a point light. Rectangle The light is a rectangle-shape...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_775d7b0a6a04
unity_docs
editor
What is `Search.SearchProvider.fetchLabel` in Unity? Explain its purpose and usage.
SearchProvider.fetchLabel public Func<SearchItem,SearchContext,string> fetchLabel ; Description Handler used to fetch and format the label of a search item. ```csharp [SearchItemProvider] internal static SearchProvider CreateProvider() { return new SearchProvider("example_tree", "Trees") { filterId = "tree:"...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_442cae899c6d
unity_docs
scripting
What is `PlayerLoop.EarlyUpdate` in Unity? Explain its purpose and usage.
EarlyUpdate struct in UnityEngine.PlayerLoop / Implemented in: UnityEngine.CoreModule Description Update phase in the native player loop. This is the C# representation of an update phase in the native player loop. It can only be used to identify the update phase in native.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eb19ffc9ed86
unity_docs
scripting
Show me a Unity C# example demonstrating `Video.VideoPlayer.started`.
e The instance of the VideoPlayer that invokes the event. Description The VideoPlayer emits this event when the video starts to play. After the VideoPlayer prepares the video and plays it, it emits this event. This event is useful if you want to play sounds, visual effects, timers or similar effects when the video ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af91464de1f7
unity_docs
math
What is `Compilation.CompilationPipeline.GetDefinesFromAssemblyName` in Unity? Explain its purpose and usage.
CompilationPipeline.GetDefinesFromAssemblyName Declaration public static string[] GetDefinesFromAssemblyName (string assemblyName ); Parameters Parameter Description assemblyName The name of the assembly without the extension. Returns string[] A string array of #define directives declared for the assembl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3b0db18b5104
unity_docs
physics
What is `Collider.OnTriggerExit` in Unity? Explain its purpose and usage.
Collider.OnTriggerExit(Collider) Parameters Parameter Description other The other Collider involved in this collision. Description OnTriggerExit is called when the Collider other has stopped touching the trigger. This message is sent to the trigger and the Collider that touches the trigger. Notes: Trigger...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d0d09355b8c9
unity_docs
scripting
Give me an overview of the `D3DHDRDisplayBitDepth` class in Unity.
Removed D3DHDRDisplayBitDepth enumeration Obsolete D3DHDRDisplayBitDepth has been replaced by HDRDisplayBitDepth. Upgrade to HDRDisplayBitDepth Description The type for the number of bits to be used when an HDR display is active in each color channel of swap chain buffers. The bit count also defines the method...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0ea5b6df2635
unity_docs
rendering
What is `Toolbars.EditorToolbarToggle.ctor` in Unity? Explain its purpose and usage.
EditorToolbarToggle Constructor Declaration public EditorToolbarToggle (); Declaration public EditorToolbarToggle (string text ); Declaration public EditorToolbarToggle ( Texture2D icon ); Declaration public EditorToolbarToggle ( Texture2D onIcon , Texture2D offIcon ); Declaration public Edit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cdb1cf755e77
unity_docs
scripting
What is `Experimental.GraphView.GraphView.AddElement` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphView.AddElement Declaration public void AddElement ( Experimental.GraphView.GraphElement graphElement ); Parameters Parameter Description graphElement The element to add. Description Add new GraphElement. Should u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb4c77fc82ff
unity_docs
editor
Show me a Unity C# example demonstrating `Search.SearchQueryError`.
SearchQueryError class in UnityEditor.Search Description Represents a query parsing error. This class is only used in the context of SearchProviders , when performing a search. It allows a SearchProvider to report error during the parsing of the search query. Here is an example of a SearchProvider that uses ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c8f0e1e4b6b8
unity_docs
physics
What is `SurfaceEffector2D.speed` in Unity? Explain its purpose and usage.
SurfaceEffector2D.speed public float speed ; Description The speed to be maintained along the surface. This speed will be maintained by applying continually applying impulse forces to the target Rigidbody2D .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc368355d99e
unity_docs
physics
What are the parameters of `PhysicsShapeGroup2D.SetShapeRadius` in Unity?
Description Sets the radius of a shape. ```csharp using UnityEngine; using UnityEngine.Assertions;public class Example : MonoBehaviour { void Start() { // Create a shape group. var shapeGroup = new PhysicsShapeGroup2D(); // Add a Circle to the shape group. var shapeIndex = shapeGr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_354839ac478d
unity_docs
scripting
What is `Pool.LinkedPool_1.Dispose` in Unity? Explain its purpose and usage.
LinkedPool<T0>.Dispose Declaration public void Dispose (); Description Removes all pooled items. If the pool contains a destroy callback then it will be called for each item that is in the pool.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab55e7a373e9
unity_docs
scripting
Show me a Unity C# example demonstrating `UIElements.RuntimePanelUtils.ScreenToPanel`.
dinates reference panel. screenPosition The screen position to transform. Returns Vector2 A position in panel coordinates that corresponds to the provided screen position. Description Transforms a screen absolute position to its equivalent local coordinate on given panel. The following example converts t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_15838cbb4fec
unity_docs
scripting
Show me a Unity C# example demonstrating `Caching.ClearCache`.
on expiration The number of seconds that AssetBundles may remain unused in the cache. Returns bool True when cache clearing succeeded, false if cache was in use. Description Removes all AssetBundle content that has been cached by the current application. This method is not available to WebPlayer applications...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_42888082b4fa
unity_docs
performance
Explain 'Optimize performance for iOS' in Unity.
This section covers optimizations which are unique to iOS devices. Topic Description Optimize for mobile Understand optimizations for mobile deployment. Measure performance with the built-in profiler Use and configure the built-in profiler for iOS. Optimize the size of the iOS Player Reduce and optimize the size of the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_36e7daa05a0b
unity_docs
input
What is `Playables.PlayableExtensions.SetPropagateSetTime` in Unity? Explain its purpose and usage.
PlayableExtensions.SetPropagateSetTime Declaration public static void SetPropagateSetTime (U playable , bool value ); Parameters Parameter Description playable The Playable used by this operation. value True to enable time propagation. Description Changes the time propagation behavior of this Playabl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_62664326b85d
unity_docs
physics
What is `Unity.IntegerTime.RationalTimeExtensions` in Unity? Explain its purpose and usage.
RationalTimeExtensions class in Unity.IntegerTime / Implemented in: UnityEngine.CoreModule Description Extension method operations for RationalTime. All binary operations throw exceptions if the rates for 2 operands do not match. Static Methods Method Description Add Adds two Rational Times together. Conve...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e200e72dcf64
unity_docs
editor
In Unity's 'Assembly Definition file format reference', what is 'Example with GUIDs and excluded platforms' and how does it work?
The following example Assembly Defintion JSON uses assembly GUIDs for references to other Assembly Definitions and the excludePlatforms key to specify an array of excluded platforms: ``` { "name": "BeeAssembly", "references": [ "GUID:17b36165d09634a48bf5a0e4bb27f4bd", "GUID:b470eee7144904e59a1064b70fa1b086", "GUID...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d0925d44b0e8
unity_docs
scripting
What is `Build.Content.WriteSceneParameters.preloadInfo` in Unity? Explain its purpose and usage.
WriteSceneParameters.preloadInfo public Build.Content.PreloadInfo preloadInfo ; Description The set of external object dependencies that need to be loaded when loading the resulting serialzied file.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f6fe9a8b4f0c
unity_docs
physics
What is `Physics.defaultContactOffset` in Unity? Explain its purpose and usage.
Physics.defaultContactOffset public static float defaultContactOffset ; Description The default contact offset of the newly created colliders. Colliders whose distance is less than the sum of their contactOffset values will generate contacts. The contact offset must be positive. Contact offset allows the collis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3e1c36e5e4a9
unity_docs
scripting
Show me a Unity code example for 'Bind to nested properties'.
in this GitHub repository . ## Create the destructible tank object Create a C# script to define a class for a tank that has health values to make it destructible. Create a project in Unity with any template. In your Project window , create a folder named bind-nested-properties to store all the files. Create a C# scri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2c782b77caea
unity_docs
animation
What is `Animations.AnimationStreamHandleUtility.WriteFloats` in Unity? Explain its purpose and usage.
AnimationStreamHandleUtility.WriteFloats Declaration public static void WriteFloats ( Animations.AnimationStream stream , NativeArray<PropertyStreamHandle> handles , NativeArray<float> buffer , bool useMask ); Parameters Parameter Description stream The animation stream. handles The PropertyStreamHandl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_844f07ff6196
unity_docs
rendering
Show me a Unity C# example demonstrating `Shader.enabledGlobalKeywords`.
obalKeywords ; Description An array containing the global shader keywords that are currently enabled. Shader keywords determine which shader variants Unity uses. For information on working with local shader keywords and global shader keywords and how they interact, see Using shader keywords with C# scripts . ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c4800b4c90f4
unity_docs
rendering
What is `Experimental.Playables.TexturePlayableOutput.Null` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. TexturePlayableOutput.Null public static Experimental.Playables.TexturePlayableOutput Null ; Description Returns an invalid TexturePlayableOutput.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_25f5e3033ce1
github
scripting
Write a Unity C# UI script for Position2D View On Map
```csharp using System.Collections; using UnityEngine; using Wrld; using Wrld.Space; using Wrld.Space.Positioners; public class Position2DViewOnMap: MonoBehaviour { static LatLong targetPosition = LatLong.FromDegrees(37.802355, -122.405848); Positioner viewPositioner; public UnityEngine.Rec...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_c5ed818e7dc0
unity_docs
rendering
Explain 'Configure Unity Accelerator in the Editor' in Unity.
To configure your Unity Editor to use Unity Accelerator , perform the following steps: Open the Project Settings window ( Edit > Project Settings ) and select Editor from the left panel. Under the Accelerator Cache Server section, set Mode to Enabled . Fill in the IP address with the cache server address (hostname/IP a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_eef12ef58430
github
scripting
Write a Unity C# script called Global Updater
```csharp using UnityEngine; namespace E { /// <summary> /// Update global system at runtime, /// do not delete this gameobject. /// </summary> // Update in editor mode. [ExecuteAlways] // Hide in "Component" Menu. [AddComponentMenu("")] // Make sure only one updater. [Singleto...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_8c786bb7d598
unity_docs
editor
Explain 'Create a tabbed menu' in Unity.
Version: 2023.2+ Tabbed menus are widely used in video games and application UI to organize and present content. Tab and TabView are powerful controls that simplify the process of creating tabbed menus. ## Example overview This example demonstrates how to create tabbed menus in a sample scene and a custom Editor wind...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_58825176af5d
unity_docs
scripting
What is `EditorGUILayout.Space` in Unity? Explain its purpose and usage.
EditorGUILayout.Space Declaration public static void Space (); Declaration public static void Space (float width ); Declaration public static void Space (float width , bool expand ); Parameters Parameter Description width The width of the empty space. Use this for horizontal layout. expand Option...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a326a9e5b629_doc_7
github
scripting
What does `Do` do in this Unity script? Explain its purpose and signature.
Turns a block of code into a coroutine that never yields anything.As soon as the coroutine is started, the passed is executed and the coroutine ends.You can use this as a code-to-coroutine conversion for a functionthat expects a coroutine, but should work immediately instead.The code that is executed as soon as this co...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.