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_594e4b80ab7e
unity_docs
animation
What is `Animations.RotationConstraint.SetSources` in Unity? Explain its purpose and usage.
RotationConstraint.SetSources Declaration public void SetSources (List<ConstraintSource> sources ); Parameters Parameter Description sources The list of sources to set. Description Sets the list of sources on the component. Throws ArgumentNullException, if the list of sources is null.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5c7d4fbd536a
unity_docs
scripting
In Unity's 'Mouse events', what is 'Unique Properties' and how does it work?
button : The button property returns an integer that identifies the mouse button pressed to trigger an event. The following table lists the integer and associated mouse button: Integer Button 0 Left button 1 Right button 2 Middle button pressedButtons : The pressedButton property returns an integer that identifies whic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3edab4988fb7
unity_docs
physics
What is `IMGUI.Controls.JointAngularLimitHandle.zMax` in Unity? Explain its purpose and usage.
JointAngularLimitHandle.zMax public float zMax ; Description Returns or specifies the maximum angular motion about the z-axis. The value returned by this property depends on the current value of the zMotion property. If it is ConfigurableJointMotion.Locked , then it will always return 0. If it is Configurab...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_569b6d31d37d
unity_docs
rendering
What is `AssetDatabase.MoveAssetsToTrash` in Unity? Explain its purpose and usage.
AssetDatabase.MoveAssetsToTrash Declaration public static bool MoveAssetsToTrash (string[] paths , List<string> outFailedPaths ); Parameters Parameter Description paths Project relative paths of the assets or folders to be deleted. outFailedPaths Project relative paths which could not be deleted. Returns...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5d3dff336938
unity_docs
xr
What is `Experimental.GlobalIllumination.Lightmapping.GetDelegate` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Lightmapping.GetDelegate Declaration public static Experimental.GlobalIllumination.Lightmapping.RequestLightsDelegate GetDelegate (); Returns RequestLightsDelegate Returns the currently set conversion delegate. Descrip...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_562892759ccc_doc_2
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The for handling the camera passthrough. Signature: ```csharp public BasePassthroughManager PassthroughManager ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de4e1bbac412
unity_docs
editor
What are the parameters of `SceneManagement.SceneManager.CreateScene` in Unity?
Returns Scene A reference to the new Scene that was created, or an invalid Scene if creation failed. Description Create an empty new Scene at runtime with the given name. The new Scene will be opened additively into the hierarchy alongside any existing Scenes that are currently open. The path of the new Scene will be e...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_199bcb7fc973
unity_docs
rendering
Explain 'Add GameObjects to reflections' in Unity.
## Add GameObjects to baked Reflection Probes The reflections captured by baked probes can only include scene objects marked as Reflection Probe Static (using the Static menu at the top left of the inspector panel for all objects). You can further refine the objects that get included in the reflection cubemap using th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_588ca9c663ec
unity_docs
math
What are the parameters of `LineRenderer.Simplify` in Unity?
Description Generates a simplified version of the original line by removing points that fall within the specified tolerance. Uses LineUtility.Simplify to perform the line simplification. This example shows how an existing line can be simplified: ```csharp using UnityEngine;// This example shows how to apply line simpli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_43d623c2444a
unity_docs
scripting
What is `ScriptableObject.CreateInstance` in Unity? Explain its purpose and usage.
ScriptableObject.CreateInstance Declaration public static ScriptableObject CreateInstance (string className ); Declaration public static ScriptableObject CreateInstance (Type type ); Parameters Parameter Description className The type of the ScriptableObject to create, as the name of the type. typ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7653162215e2
unity_docs
scripting
Show me a Unity C# example demonstrating `Pool.ObjectPool_1`.
the constructor. Important : ObjectPool<T> stores its pooled object instances in a stack-like collection, so don't assume physical contiguity of the objects in memory. ObjectPool<T> is not safe to call from background threads. For more information on the concept and application of object pooling, refer to Pooli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28d7bc336b3d
unity_docs
scripting
What is `Experimental.GraphView.GraphViewToolWindow.GetExtraPaneTypes` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphViewToolWindow.GetExtraPaneTypes Declaration public IEnumerable<Type> GetExtraPaneTypes (); Returns IEnumerable<Type> The extra panes that are specific to the window. Description Gets the extra panes associated wit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3880da017921
unity_docs
scripting
What is `SerializedObject.ctor` in Unity? Explain its purpose and usage.
SerializedObject Constructor Declaration public SerializedObject ( Object obj ); Description Create SerializedObject for inspected object. Additional resources: Update . Declaration public SerializedObject (Object[] objs ); Description Create SerializedObject for inspected object. Additional resource...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b01c0d130119
unity_docs
scripting
Give me an overview of the `AwaitableCompletionSource` class in Unity.
AwaitableCompletionSource class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Objects allowing to control completion of an Awaitable object from user code. Properties Property Description Awaitable Get the awaitable controlled by the completion source. Public Methods Method Descripti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4558cc75dfdf
unity_docs
ui
Explain 'Create a custom style for a custom control' in Unity.
Version : 2023.2+ This example demonstrates how to use custom USS variables in a custom control. ## Example overview This example creates a custom control that reads two colors from USS and uses them to generate a texture. You can find the completed files that this example creates in this GitHub repository . ## Crea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c137ae2cb432
unity_docs
rendering
What are the parameters of `Mesh.RecalculateTangents` in Unity?
Description Recalculates the tangents of the Mesh from the normals and texture coordinates. After modifying the vertices and the normals of the Mesh, tangents need to be updated if the Mesh is rendered using Shaders that reference normal maps. Unity calculates tangents using the vertex positions, normals and texture co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_034b8da43040
unity_docs
scripting
What is `UIElements.StylePropertyNameCollection.Contains` in Unity? Explain its purpose and usage.
StylePropertyNameCollection.Contains Declaration public bool Contains ( UIElements.StylePropertyName stylePropertyName ); Parameters Parameter Description stylePropertyName The element to locate in the <see cref="StylePropertyNameCollection" />. Returns bool true if the StylePropertyNameCollection con...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c29fa7d304ea
unity_docs
editor
What is `Android.AndroidProjectFiles.SetGradleSettingsFile` in Unity? Explain its purpose and usage.
AndroidProjectFiles.SetGradleSettingsFile Declaration public void SetGradleSettingsFile (string path , Unity.Android.Gradle.GradleSettingsFile gradleSettings ); Parameters Parameter Description path The file path to place the settings.gradle file at. This path is relative to the gradle project path. gr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d3fa0aa11a32
unity_docs
math
What is `ArticulationBody.TeleportRoot` in Unity? Explain its purpose and usage.
ArticulationBody.TeleportRoot Declaration public void TeleportRoot ( Vector3 position , Quaternion rotation ); Parameters Parameter Description position The new position of the root articulation body. rotation The new orientation of the root articulation body. Description Teleport the root body of t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2916b067177a
unity_docs
scripting
What is `Progress.Item.Finish` in Unity? Explain its purpose and usage.
Progress.Item.Finish Declaration public void Finish ( Progress.Status finishedStatus ); Parameters Parameter Description finishedStatus The status of the associated task when the progress indicator finishes. Indicates whether the task succeeded, failed, or was canceled. Description Marks the progress indi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_42300a63259e
unity_docs
ui
Show me a Unity C# example demonstrating `Overlays.DockZone`.
DockZone enumeration Description DockZone describes the area of the screen that an Overlay is displayed in. Use DockZone in an OverlayAttribute to set the default location for an Overlay . ```csharp using UnityEditor; using UnityEditor.Overlays; using UnityEngine; using UnityEngine.UIElements;// Use Overla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_66d5de5a71c4
unity_docs
physics
What is `Collider.layerOverridePriority` in Unity? Explain its purpose and usage.
Collider.layerOverridePriority public int layerOverridePriority ; Description A decision priority assigned to this Collider used when there is a conflicting decision on whether a Collider can contact another Collider . The Layer Collision Matrix defines which layers can contact other layers. Additionally, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d3b478ea19ed
unity_docs
scripting
Explain 'Load a keystore' in Unity.
This page explains how to load an existing keystore and select a key from it to use as the project key. This is relevant if you want to publish your application, because you must provide a key from a keystore when you sign the application. To load an existing keystore: Open Android Publishing Settings . Under the Proje...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b427120d710d
unity_docs
physics
In Unity's 'Wheel collider suspension', what is 'Spring' and how does it work?
In a real-world suspension system, the spring connects the wheel and axle to the vehicle’s frame and body, and sustains the weight of the vehicle body. The spring extends and compresses in response to changes in the terrain , and absorbs some of the upward force from the ground, so that the vehicle’s body doesn’t respo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_90da1d300329
unity_docs
scripting
What is `UIElements.MouseMoveEvent` in Unity? Explain its purpose and usage.
MouseMoveEvent class in UnityEngine.UIElements / Inherits from: UIElements.MouseEventBase_1 / Implemented in: UnityEngine.UIElementsModule Description This event is sent when the mouse moves. The mouse move event is sent to the visual element under the current mouse position whenever the mouse position ha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_061ba61744b6
unity_docs
editor
What is `Search.SearchProvider.startDrag` in Unity? Explain its purpose and usage.
SearchProvider.startDrag public Action<SearchItem,SearchContext> startDrag ; Description If implemented, the item supports drag. It is up to the SearchProvider to properly set up the DragAndDrop manager. ```csharp [SearchItemProvider] internal static SearchProvider CreateProvider() { return new SearchProvider(...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b8f065537cf4
unity_docs
scripting
What is `UIElements.DragExitedEvent` in Unity? Explain its purpose and usage.
DragExitedEvent class in UnityEngine.UIElements / Inherits from: UIElements.DragAndDropEventBase_1 / Implemented in: UnityEngine.UIElementsModule Description The event sent to a dragged element when the drag and drop process ends. Constructors Constructor Description DragExitedEvent Constructor. Pr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2dcc2799d814
unity_docs
animation
What is `Animations.PropertySceneHandle.IsResolved` in Unity? Explain its purpose and usage.
PropertySceneHandle.IsResolved Declaration public bool IsResolved ( Animations.AnimationStream stream ); Parameters Parameter Description stream The AnimationStream managing this handle. Returns bool Returns true if the handle is resolved, false otherwise. Description Returns whether or not th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_10ea35ed7e66
unity_docs
scripting
What are the parameters of `Input.GetButton` in Unity?
Returns bool True when an axis has been pressed and not released. Description Returns true while the virtual button identified by buttonName is held down. 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 Sy...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ef087b0fe1a2
unity_docs
rendering
What is `BoneWeight1` in Unity? Explain its purpose and usage.
BoneWeight1 struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Describes a bone weight that affects a vertex in a mesh. This struct can be used with the Mesh.GetAllBoneWeights , Mesh.SetBoneWeights and Mesh.GetBonesPerVertex APIs to describe up to 255 bone weights per vertex. Note t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6be598d2ccbc
unity_docs
animation
What is `Animator.recorderStartTime` in Unity? Explain its purpose and usage.
Animator.recorderStartTime public float recorderStartTime ; Description Start time of the first frame of the buffer relative to the frame at which StartRecording was called. For example, if we started recording at frame 10, and the buffer is 5 frames long. If the buffer is not initialized ( StartRecording i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d6d3ff99fef0
unity_docs
scripting
What is `Color32.g` in Unity? Explain its purpose and usage.
Color32.g public byte g ; Description Green component of the color. ```csharp using UnityEngine;public class Example : MonoBehaviour { Color32 color = Color.white; void Start() { color.g = 0; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6044ee5640a1
unity_docs
rendering
What is `Search.SearchUtils.GetTypeIcon` in Unity? Explain its purpose and usage.
SearchUtils.GetTypeIcon Declaration public static Texture2D GetTypeIcon (ref Type type ); Parameters Parameter Description type Type. Returns Texture2D Icon for that type. Description Returns a thumbnail for a given type that can be displayed in a search view. See SearchProvider.fetchThumbnail . ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b9896a35f8cb
unity_docs
rendering
Show me a Unity code example for 'Apply default presets to assets by folder'.
ng logic: Apply the preset that is in the same folder as the asset. If there is no preset in the folder, apply the preset from a parent folder. If there are no presets in parent folders, apply the default preset configured in the Preset Manager window. To use this example, create a new folder named Editor in the Projec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3de96039119f
unity_docs
rendering
Explain 'Debug Metal graphics' in Unity.
Unity’s Frame Debugger supports Metal and should be the first tool you use to debug graphics issues in a Unity application that uses Metal. For more in-depth, Metal-specific graphics issues, Xcode provides graphics debugging tools such as API validation and shader validation. Note : Enabling validation increases CPU re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5b6bd307bedf
unity_docs
editor
What is `Unity.Profiling.Editor.ProfilerModule.ProfilerWindow` in Unity? Explain its purpose and usage.
ProfilerModule.ProfilerWindow protected ProfilerWindow ProfilerWindow ; Description The Profiler window that the module instance belongs to. Use this property to construct a ProfilerModuleViewController while overriding ProfilerModule.CreateDetailsViewController . You can also use this property to subscrib...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8e91fe11d3c2
unity_docs
ui
Show me a Unity C# example demonstrating `GUI.enabled`.
GUI.enabled public static bool enabled ; Description Is the GUI enabled? Set this value to false to disable all GUI interaction. All controls will be draw semi-transparently, and will not respond to user input. Enabled / Disabled GUI controls. ```csharp using UnityEngine; using System.Collections;public class...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dcfc9676b80e
unity_docs
editor
Show me a Unity C# example demonstrating `BuildAssetBundleOptions.UncompressedAssetBundle`.
eOptions.UncompressedAssetBundle Description Don't compress the data when creating the AssetBundle. Uncompressed bundles are faster to build and load, but, because they are larger, take longer to download. Uncompressed AssetBundles are 16-byte aligned. Additional resources: AssetBundles compression , BuildAsset...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bc95f4184d1a
unity_docs
rendering
In Unity's 'CameraEvent and LightEvent events order reference for the Built-In Render Pipeline', what is 'Forward rendering path' and how does it work?
BeforeDepthTexture : Unity renders depth for opaque geometry. AfterDepthTexture BeforeDepthNormalsTexture : Unity renders depth normals for opaque geometry. AfterDepthNormalsTexture : Unity renders shadows. See LightEvent order of execution . BeforeForwardOpaque : Unity renders opaque geometry. AfterForwardOpaque Befor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_068f31b3d5af
unity_docs
animation
Give me an overview of the `AnimatorUpdateMode` class in Unity.
AnimatorUpdateMode enumeration Description The update mode of the Animator. Properties Property Description Normal Animator updates in the Update loop. Fixed Animator updates in the FixedUpdate loop. Use this mode to evaluate animation independent of frame rate. UnscaledTime Animator updates independently of ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f2783b0ba6f1
unity_docs
editor
What is `iOS.Xcode.PBXProject.GetUnityFrameworkTargetGuid` in Unity? Explain its purpose and usage.
PBXProject.GetUnityFrameworkTargetGuid Declaration public string GetUnityFrameworkTargetGuid (); Returns string The GUID for the framework target. Description Returns the GUID of the framework target in Unity project. Returns the GUID of the framework target. This target includes source code, plugins, dep...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d807a62f390e
unity_docs
rendering
What is `LightRenderMode.Auto` in Unity? Explain its purpose and usage.
LightRenderMode.Auto Description Automatically choose the render mode. This chooses whether to render the Light as a pixel or vertex light (recommended and default). Additional resources: light component .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a1e2c17c5f7e
unity_docs
scripting
What is `SystemLanguage.Afrikaans` in Unity? Explain its purpose and usage.
SystemLanguage.Afrikaans Description Afrikaans. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { //This checks if your computer's operating system is in the Afrikaans language if (Application.systemLanguage == SystemLanguage.Afrikaans) { //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_4afd2139560a
unity_docs
animation
What is `AnimationUtility.TangentMode.Auto` in Unity? Explain its purpose and usage.
AnimationUtility.TangentMode.Auto Description The tangents are automatically set to make the curve go smoothly through the key. This was the standard tangent mode prior to Unity 5.5, however way the curve was calculated would sometimes cause the value to overshoot before reaching the proper value. In Unity 5.5 and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49d460db1f5f
unity_docs
scripting
What is `SystemInfo.IsFormatSupported` in Unity? Explain its purpose and usage.
SystemInfo.IsFormatSupported Declaration public static bool IsFormatSupported ( Experimental.Rendering.GraphicsFormat format , Experimental.Rendering.GraphicsFormatUsage usage ); Parameters Parameter Description format The GraphicsFormat format to look up. usage The GraphicsFormatUsage usage to loo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_952d3ed4f130
unity_docs
editor
What is `Build.Player.ScriptCompilationResult` in Unity? Explain its purpose and usage.
ScriptCompilationResult struct in UnityEditor.Build.Player Description Struct with result information returned from the PlayerBuildInterface.CompilePlayerScripts API. Note: this struct and its members exist to provide low-level support for the Scriptable Build Pipeline package. This is intended for internal u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2b13dc62723b
unity_docs
rendering
Explain 'Graphics performance and profiling reference' in Unity.
Explore properties and settings in the Frame Debugger window and the Rendering Statistics window. Page Description Frame Debugger window reference Explore properties and settings in the Frame Debugger window to get more information about rendering events. Frame Debugger Event Information reference Explore properties an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a985b18b451b
unity_docs
scripting
What is `Experimental.GraphView.MiniMap.windowed` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. MiniMap.windowed public bool windowed ; Description Set to true when the MiniMap displays in a separate window. Set to false when the MiniMap displays in the GraphView.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a67324404877
unity_docs
scripting
What is `SearchService.ProjectSearch.UnregisterEngine` in Unity? Explain its purpose and usage.
ProjectSearch.UnregisterEngine Declaration public static void UnregisterEngine ( SearchService.IProjectSearchEngine engine ); Parameters Parameter Description engine The Project search engine to unregister. Description Unregisters a dynamically registered engine.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5603dc3e42ec
unity_docs
xr
What is `PackageManager.Client.SearchAll` in Unity? Explain its purpose and usage.
Client.SearchAll Declaration public static PackageManager.Requests.SearchRequest SearchAll (); Declaration public static PackageManager.Requests.SearchRequest SearchAll (bool offlineMode ); Parameters Parameter Description offlineMode Specifies whether or not the Package Manager requests the latest ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fd59a96ccbd8
unity_docs
scripting
What is `LightTransport.RadeonRaysContext` in Unity? Explain its purpose and usage.
RadeonRaysContext class in UnityEngine.LightTransport Implements interfaces: IDeviceContext Description RadeonRaysContext implements the IDeviceContext interface. It uses the RadeonRays SDK for ray-triangle intersection testing and the OpenCL 1.2 API for computations. Constructors Constructor Description R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_58ec53f14a3e
unity_docs
scripting
Show me a Unity C# example demonstrating `AI.NavMeshAgent.ActivateCurrentOffMeshLink`.
Link (bool activated ); Parameters Parameter Description activated Is the link activated? Description Enables or disables the current off-mesh link. This function activates or deactivates the off-mesh link where the agent is currently waiting. This is useful for granting access to newly discovered areas of t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c6e21e185726
unity_docs
math
What is `Rendering.RayTracingShader.SetVector` in Unity? Explain its purpose and usage.
RayTracingShader.SetVector Declaration public void SetVector (string name , Vector4 val ); Declaration public void SetVector (int nameID , Vector4 val ); Parameters Parameter Description name The name of the property being set. nameID The ID of the property as given by Shader.PropertyToID. val ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_04301b480408
unity_docs
physics
Show me a Unity C# example demonstrating `RaycastHit.distance`.
In the case of a ray, the distance represents the magnitude of the vector from the ray's origin to the impact point. In the case of a swept volume or sphere cast, the distance represents the magnitude of the vector from the origin point to the translated point at which the volume contacts the other collider. Note that ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cc3438d6e53b
unity_docs
ui
In Unity's 'Use UXML instances as templates', what is 'Use a UXML Document as a template' and how does it work?
To use an existing UXML Document in your project as a template, do the following: Under the Library ’s Project tab, find the UXML Asset (.uxml ) you wish to instantiate. Drag it into the Hierarchy like an element in the Library . A Template Instance appears in the Hierarchy like a normal element of type TemplateContain...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2190e7c8e872
unity_docs
rendering
What is `CustomRenderTexture.cubemapFaceMask` in Unity? Explain its purpose and usage.
CustomRenderTexture.cubemapFaceMask public uint cubemapFaceMask ; Description The bit field that you can use to enable or disable update on each of the cubemap faces. The bit order from least to most significant bit is as follows: +X, -X, +Y, -Y, +Z, -Z.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_fb052fdaeec5_doc_7
github
scripting
What does `Convert` do in this Unity script? Explain its purpose and signature.
Convert all table data. Signature: ```csharp public static IList Convert(Type dataType, string csvContent, char cellSeparator = CSVDataHelper.CommaCharacter, bool supportCellMultiline = true) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_91aea1c621da
unity_docs
editor
What is `BuildOptions.ConnectWithProfiler` in Unity? Explain its purpose and usage.
BuildOptions.ConnectWithProfiler Description Start the Player with a connection to the Profiler in the Editor. When the build starts, an open Profiler window automatically connects to the Player and starts profiling. When you build the Player by enabling the BuildOptions.AutoRunPlayer option, the Editor automatic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c20b9a5153ab
unity_docs
ui
What is `IMGUI.Controls.TreeView.SelectionClick` in Unity? Explain its purpose and usage.
TreeView.SelectionClick Declaration protected void SelectionClick ( IMGUI.Controls.TreeViewItem item , bool keepMultiSelection ); Parameters Parameter Description item TreeViewItem clicked. keepMultiSelection If true then keeps the multiselection when clicking on a item already part of the selection. If ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f82cb51563a0
github
scripting
Write a Unity C# script called Locator
```csharp using System; using System.Collections.Generic; using RMC.Core.Events; using UnityEngine; namespace RMC.Mini { // Namespace Properties ------------------------------ // Class Attributes ---------------------------------- /// <summary> /// Locator class for managing items of type TBase. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fd07278ef0cf
unity_docs
xr
What is `Cache.spaceOccupied` in Unity? Explain its purpose and usage.
Cache.spaceOccupied public long spaceOccupied ; Description Returns the used disk space in bytes. Initially this is 0. As you download AssetBundles to the cache, this will increase. If insufficient space is available in the cache to store a requested AssetBundle, the least-recently-used cached AssetBundles in t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ed0bf25117d6
unity_docs
editor
Show me a Unity C# example demonstrating `AssetImporters.AssetImporterEditor.OnDisable`.
AssetImporterEditor.OnDisable Declaration public void OnDisable (); Description This function is called when the editor object goes out of scope. This is also called when the editor is destroyed and can be used for any cleanup code. When scripts are reloaded after compilation has finished, OnDisable will be cal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_00989a7de80d
unity_docs
rendering
What is `Rendering.RayTracingShader.SetFloats` in Unity? Explain its purpose and usage.
RayTracingShader.SetFloats Declaration public void SetFloats (string name , params float[] values ); Declaration public void SetFloats (int nameID , params float[] values ); Parameters Parameter Description name The name of the property being set. nameID The ID of the property as given by Shader.Pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b3b7a41960f6
unity_docs
editor
What is `Search.SearchProvider.toObject` in Unity? Explain its purpose and usage.
SearchProvider.toObject public Func<SearchItem,Type,Object> toObject ; Description Returns any valid Unity object held by the search item. ```csharp [SearchItemProvider] internal static SearchProvider CreateProvider() { return new SearchProvider("example_tree", "Trees") { filterId = "tree:", priority = 9999...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dcd552aeceff
unity_docs
editor
What is `PrefabUtility.ReplacePrefabAssetOfPrefabInstance` in Unity? Explain its purpose and usage.
PrefabUtility.ReplacePrefabAssetOfPrefabInstance Declaration public static void ReplacePrefabAssetOfPrefabInstance ( GameObject prefabInstanceRoot , GameObject prefabAssetRoot , InteractionMode mode ); Declaration public static void ReplacePrefabAssetOfPrefabInstance ( GameObject prefabInstanceRoot , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9078f1719cde
unity_docs
physics
Explain 'Use collisions to trigger other events' in Unity.
When two colliders make contact, they call functions that you can use to trigger other events in your project. You can place any code you like in these functions to respond to the collision event. Collider events require configuration via C# script; you cannot configure them using only the user interface. There are two...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b2fb22ea22f6
unity_docs
math
What is `U2D.SpriteDataAccessExtensions` in Unity? Explain its purpose and usage.
SpriteDataAccessExtensions class in UnityEngine.U2D / Implemented in: UnityEngine.CoreModule Description A list of methods designed for reading and writing to the rich internal data of a Sprite. It is now possible to read and write to all the channels of the VertexAttribute, BoneWeight, BindPose and the SpriteB...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0eb35307c645
unity_docs
audio
What is `AudioChorusFilter.rate` in Unity? Explain its purpose and usage.
AudioChorusFilter.rate public float rate ; Description Chorus modulation rate in hz. 0.0 to 20.0. Default = 0.8 hz. ```csharp using UnityEngine;[RequireComponent(typeof(AudioSource))] [RequireComponent(typeof(AudioChorusFilter))] public class Example : MonoBehaviour { // Set the rate on the chorus filter to 1...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c87db7dbf7c1
unity_docs
physics
In Unity's 'Apply constant force to a Rigidbody', what is 'Configure constant forward acceleration' and how does it work?
To make a GameObject constantly accelerate forward (for example, to make it behave like a rocket), do the following: Add a Constant Force component to the GameObject. On the Constant Force component, set the Relative Force Z axis to a positive value. On the Rigidbody, disable Use Gravity . This ensures that there is no...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b579cd4141a4
unity_docs
scripting
Show me a Unity C# example demonstrating `FrameTiming.firstSubmitTimestamp`.
FrameTiming.firstSubmitTimestamp public ulong firstSubmitTimestamp ; Description This is the CPU clock time of the time when the first job was submitted to GPU. Use FrameTimingManager.GetCpuTimerFrequency to convert timestamps to seconds. ```csharp using UnityEngine;class Example { static readonly double k_...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ea62e107f50b
unity_docs
xr
Explain 'Deploy a Windows or UWP app with the Windows Device Portal' in Unity.
You can use the Windows Device Portal to build and run Windows or Universal Windows Platform (UWP) applications to a remote Windows 10+ device directly from the Unity Editor, alleviating the need to generate a Visual Studio project. Being connected remotely to a remote Windows device allows you to make faster iteration...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ae58435f842
unity_docs
math
What is `Mathf` in Unity? Explain its purpose and usage.
Mathf struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description A collection of common math functions. Static Properties Property Description Deg2Rad Degrees-to-radians conversion constant (Read Only). Epsilon The smallest positive non-zero value that a float can represent. Using Mathf.Eps...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db60a649666a
unity_docs
scripting
What is `Mesh.GetVertexAttributeStream` in Unity? Explain its purpose and usage.
Mesh.GetVertexAttributeStream Declaration public int GetVertexAttributeStream ( Rendering.VertexAttribute attr ); Parameters Parameter Description attr The vertex data attribute to check for. Returns int Stream index of the data attribute, or -1 if it is not present. Description Gets the vertex buf...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b8c6fbc3bf3a
unity_docs
scripting
What is `UIElements.IStyle.position` in Unity? Explain its purpose and usage.
IStyle.position public StyleEnum<Position> position ; Description Element's positioning in its parent container. This property is used in conjunction with left, top, right and bottom properties.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7e14783d4491
unity_docs
scripting
What is `UIElements.CallbackEventHandler.HasBubbleUpHandlers` in Unity? Explain its purpose and usage.
CallbackEventHandler.HasBubbleUpHandlers Declaration public bool HasBubbleUpHandlers (); Returns bool True if the object has event handlers for the BubbleUp phase. Description Return true if event handlers for the event propagation BubbleUp phase have been attached to this object.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d757e2c11118
unity_docs
scripting
What is `UIElements.Vector3IntField` in Unity? Explain its purpose and usage.
Vector3IntField class in UnityEngine.UIElements / Inherits from: UIElements.BaseCompositeField_3 / Implemented in: UnityEngine.UIElementsModule Description A Vector3Int field. For more information, refer to UXML element Vector3IntField . Static Properties Property Description inputUssClassName USS ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_59bc3049a568
unity_docs
ui
What is `UIElements.MultiColumnListViewController` in Unity? Explain its purpose and usage.
MultiColumnListViewController class in UnityEngine.UIElements / Inherits from: UIElements.BaseListViewController / Implemented in: UnityEngine.UIElementsModule Description Multi-column list view controller. View controllers of this type are meant to take care of data virtualized by any MultiColumnListView i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_5c5534dc9b4d
github
scripting
Write a Unity C# MonoBehaviour script called Global Test5
```csharp using UnityEngine; public class GlobalTest5 : MonoBehaviourExtended, ITest { [GlobalComponent] private InputManager inputManager; private void Start() { if (!Test()) { Debug.LogError("Test failed: " + this); } } public bool Test() { i...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_258d73ec2863
unity_docs
scripting
In Unity's 'Enable optional features for QNX', what is 'Command line arguments' and how does it work?
You can launch the Unity QNX Player from the command line and pass arguments to change how the Player executes. Note : All command line arguments have precedence over the settings configured in the Unity Editor. Command line argument Description -platform-qnx-graphics-conf Configure the path to the graphics.conf to ove...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_376019036f23
unity_docs
editor
What is `PlayerSettings.GetScriptingDefineSymbols` in Unity? Explain its purpose and usage.
PlayerSettings.GetScriptingDefineSymbols Declaration public static string GetScriptingDefineSymbols ( Build.NamedBuildTarget buildTarget ); Parameters Parameter Description buildTarget The NamedBuildTarget . Description Gets the array of symbols for script compilation for the build target you select. Sy...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c9ab1bbd8f0f
unity_docs
rendering
What is `Material.ctor` in Unity? Explain its purpose and usage.
Material Constructor Declaration public Material ( Shader shader ); Declaration public Material ( Material source ); Parameters Parameter Description shader Create a material with a given Shader . source Create a material by copying all properties from another material. Description Create a temp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2a8ca4249814
unity_docs
rendering
What is `Material.IsChildOf` in Unity? Explain its purpose and usage.
Material.IsChildOf Declaration public bool IsChildOf ( Material ancestor ); Parameters Parameter Description ancestor The specific ancestor to find in the hierarchy. Returns bool True if the given material is an ancestor of this Material. Description Returns True if the given material is an ancesto...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd9ce919ff27
unity_docs
scripting
What is `UIElements.PointerCancelEvent.ctor` in Unity? Explain its purpose and usage.
PointerCancelEvent Constructor Declaration public PointerCancelEvent (); Description Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2e8cfb2a9add
unity_docs
math
What is `Matrix4x4.isIdentity` in Unity? Explain its purpose and usage.
Matrix4x4.isIdentity public bool isIdentity ; Description Checks whether this is an identity matrix. (Read Only) An identity matrix contains 1.0 in the main diagonal, and 0.0 for every other elements. Additional resources: Matrix4x4.identity property.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4556844cdcae
unity_docs
scripting
What is `Profiling.Recorder.gpuSampleBlockCount` in Unity? Explain its purpose and usage.
Recorder.gpuSampleBlockCount public int gpuSampleBlockCount ; Description Gets the number of Begin/End time pairs that the GPU executed during a frame. The Recorder has a three frame delay so this gives the timings for the frame that was three frames before the one that you access this property on. (Read Only). ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b7810d5d8993
unity_docs
animation
Give me an overview of the `AnimatorCullingMode` class in Unity.
AnimatorCullingMode enumeration Description Culling mode for the Animator. Properties Property Description AlwaysAnimate Always animate the entire character. Object is animated even when offscreen. CullUpdateTransforms Retarget, IK and write of Transforms are disabled when renderers are not visible. CullCompl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c0ce41c42d77
unity_docs
math
What is `GUILayout.ScrollViewScope.ctor` in Unity? Explain its purpose and usage.
GUILayout.ScrollViewScope Constructor Declaration public GUILayout.ScrollViewScope ( Vector2 scrollPosition , params GUILayoutOption[] options ); Declaration public GUILayout.ScrollViewScope ( Vector2 scrollPosition , bool alwaysShowHorizontal , bool alwaysShowVertical , params GUILayoutOption[] options ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9116931a4fcb
unity_docs
rendering
Explain 'Define custom data formats for particles in the Built-In Render Pipeline' in Unity.
The Custom Data module allows you to define custom data formats in the Editor to be attached to particles . You can also set this in a script. See documentation on Particle System vertex streams for more information on how to set custom data from a script and feed that data into your shaders . Data can be in the form o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d0c95fa66820
unity_docs
scripting
What is `SceneManagement.Stage.OnFirstTimeOpenStageInSceneView` in Unity? Explain its purpose and usage.
Stage.OnFirstTimeOpenStageInSceneView Declaration protected void OnFirstTimeOpenStageInSceneView ( SceneView sceneView ); Parameters Parameter Description sceneView The Scene view the Stage is opened in. Description Unity calls this method the first time a Stage is opened for a specific Asset, for a speci...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3256fbac2ba2
unity_docs
scripting
Show me a Unity C# example demonstrating `Animations.PropertySceneHandle`.
PropertySceneHandle struct in UnityEngine.Animations / Implemented in: UnityEngine.AnimationModule Description Handle to read a Component property on an object in the Scene. PropertySceneHandle are read-only. ```csharp using UnityEngine; using UnityEngine.Playables; using UnityEngine.Animations;public struct...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4a711b07c838
unity_docs
animation
What is `Animations.AnimatorControllerPlayable.GetFloat` in Unity? Explain its purpose and usage.
AnimatorControllerPlayable.GetFloat Declaration public float GetFloat (string name ); Declaration public float GetFloat (int id ); Parameters Parameter Description name The parameter name. id The parameter ID. Returns float The value of the parameter. Description Returns the value of the given...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d38af3527fa6
unity_docs
scripting
Explain 'Scale Constraint component' in Unity.
A Scale Constraint component resizes a GameObject to match the scale of its source GameObjects. ## Properties Property Description Activate After you resize the constrained GameObject and its source GameObjects, click Activate to save this information. Activate saves the current offset from the source GameObjects in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1ffdcbbe2895
unity_docs
rendering
Explain 'Create particles that change velocity over time' in Unity.
To create particles that drift in a particular direction, use the Velocity over Lifetime module’s Linear X, Y and Z curves. To create effects with particles that spin around a center position, use the use the Velocity over Lifetime module’s Orbital velocity values. Additionally, you can propel particles towards or away...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b0f82b6f1425
unity_docs
animation
Give me an overview of the `SharedBetweenAnimatorsAttribute` class in Unity.
SharedBetweenAnimatorsAttribute class in UnityEngine / Implemented in: UnityEngine.AnimationModule Description The SharedBetweenAnimatorsAttribute specifies that this StateMachineBehaviour is instantiated only once and shared by all Animator instances. This attribute reduces the memory footprint for each control...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28170a85c736
unity_docs
ui
What is `UIElements.VisualElementFocusRing` in Unity? Explain its purpose and usage.
VisualElementFocusRing class in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Implements interfaces: IFocusRing Description Implementation of a linear focus ring. Elements are sorted according to their focusIndex. Properties Property Description defaultFocusOrder The focus order...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d8122bb9c2bd
unity_docs
scripting
What is `SceneManagement.Stage.OnReturnToStage` in Unity? Explain its purpose and usage.
Stage.OnReturnToStage Declaration protected void OnReturnToStage (); Description Unity calls this method when you return to a Stage that is already open. A Stage can remain open even after another Stage becomes the active Stage. Unity only closes a Stage once it's no longer visible in the Scene view breadcrumb ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a05f5e84abb7
unity_docs
scripting
What is `UIElements.PropertyField.label` in Unity? Explain its purpose and usage.
PropertyField.label public string label ; Description Optionally overwrite the label of the generate property field. If no label is provided the string will be taken from the SerializedProperty.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5cef7d984ed2
unity_docs
rendering
What is `Rendering.RayTracingSubMeshFlagsConfig.transparentMaterials` in Unity? Explain its purpose and usage.
RayTracingSubMeshFlagsConfig.transparentMaterials public Rendering.RayTracingSubMeshFlags transparentMaterials ; Description The corresponding RayTracingSubMeshFlags value for transparent Materials. Additional resources: RayTracingAccelerationStructure.CullInstances .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f899b463def2
unity_docs
scripting
Explain 'Building and delivering for macOS' in Unity.
This section has information about how to build and publish your macOS application. Topic Description Build a macOS application Build a Unity application for macOS. macOS build settings reference Reference documentation for macOS build settings. Code sign and notarize your macOS application Details the process of code ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_127184c867ba
unity_docs
ui
In Unity's 'Visual elements reference', what is 'Built-in controls' and how does it work?
The following table is a reference of all built-in controls available for UI Toolkit. Element Bindable Data type Namespace C# class BoundsField Yes UnityEngine.Bounds UnityEngine.UIElements UnityEngine.UIElements.BoundsField BoundsIntField Yes UnityEngine.BoundsInt UnityEngine.UIElements UnityEngine.UIElements.BoundsIn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.