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_f08d29870b5d
unity_docs
rendering
Show me a Unity C# example demonstrating `AssetPostprocessor.OnPostprocessMaterial`.
aterial) Description Add this function to a subclass to get a notification when a new Material is created during an import of a ModelImporter. Use this method to modify the properties of newly created Material assets during import. Note: This method is only called by the ModelImporter when the ModelImporter.Materia...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f5ffc6aa6c6
unity_docs
rendering
What is `Profiling.Sampler.isValid` in Unity? Explain its purpose and usage.
Sampler.isValid public bool isValid ; Description Returns true if Sampler is valid. (Read Only) Invalid Sampler represents non-existing Profiler label. Note: At the moment all built-in counters are available only in the Editor and Development Players. Sampler.Get in non-Development Players returns invalid Sa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0838ccad95d4_doc_1
github
scripting
What does `Awake` do in this Unity script? Explain its purpose and signature.
Awake is called when the script instance is being loaded. Signature: ```csharp private void Awake() ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_7ea59e401f3f
unity_docs
rendering
What is `Rendering.ScriptableRenderContext.PopDisableApiRenderers` in Unity? Explain its purpose and usage.
ScriptableRenderContext.PopDisableApiRenderers Declaration public static void PopDisableApiRenderers (); Description Enable the immediate addition and removal of renderer scene nodes to the scene arrays.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6538732463af
unity_docs
physics
Explain 'Particle System module component reference' in Unity.
The Particle System component has a powerful set of properties that are organized into modules for ease of use. This section of the manual covers each of the modules in detail. Topic Description Activate and access component modules Activate component modules on a Particle System to access and change the properties of ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1af9eb92aa61
unity_docs
animation
What is `Experimental.Animations.AnimationPlayableOutputExtensions.SetAnimationStreamSource` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. AnimationPlayableOutputExtensions.SetAnimationStreamSource Declaration public static void SetAnimationStreamSource ( Animations.AnimationPlayableOutput output , Experimental.Animations.AnimationStreamSource streamSource ); ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aadfa803383d
unity_docs
scripting
What is `SceneManagement.StageUtility.GetCurrentStage` in Unity? Explain its purpose and usage.
StageUtility.GetCurrentStage Declaration public static SceneManagement.Stage GetCurrentStage (); Returns Stage The current Stage that is currently being rendered in the Scene view and shown in the Hierarchy. Description The current Stage can either be the MainStage or any other opened Stage , visualiz...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_86330e420705
unity_docs
scripting
Explain 'Call C/C++/C# functions from Unity C# scripts' in Unity.
You can call functions from your C, C++, or C# plug-ins in your Unity projects. Unity uses Emscripten to compile your sources into WebAssembly from C/C++/C# code, so you can write plug-ins in C/C++/C# code and call these functions from your Unity C# scripts . To call functions from your JavaScript plug-ins instead, ref...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_58fbb67b731d
unity_docs
scripting
What is `UIElements.BaseVerticalCollectionView.itemsSource` in Unity? Explain its purpose and usage.
BaseVerticalCollectionView.itemsSource public IList itemsSource ; Description The data source for collection items. This list contains the items that the BaseVerticalCollectionView displays.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0d351936d75b_doc_3
github
scripting
What does `StartReplay` do in this Unity script? Explain its purpose and signature.
Updates the control UI when the user starts playback of a eye gaze log file. Signature: ```csharp public void StartReplay() ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_719d3435d257
unity_docs
physics
What is `ContactPair.GetContactPointFaceIndex` in Unity? Explain its purpose and usage.
ContactPair.GetContactPointFaceIndex Declaration public uint GetContactPointFaceIndex (int contactIndex ); Parameters Parameter Description contactIndex The ContactPairPoint index. Returns uint Index of a face this contact point belongs to. Description Get the index of a face that a particular cont...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_043335016036
unity_docs
rendering
Explain 'Configuring lightmaps and baking' in Unity.
Resources for selecting CPU or GPU lightmapping, and changing how GameObjects store lighting in lightmaps . Page Description Select the CPU or GPU for baking Configure Unity to do lightmapping calculations on the CPU with system memory, or on the GPU with video memory. Group GameObjects together in a lightmap with Bake...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0e22126a6e9a
unity_docs
rendering
Explain 'Compute shader Import Settings window reference' in Unity.
View the properties and compiled code of a compute shader . ## Imported object Property Description Kernels Displays the names of the kernels the shader code defines, and which graphics APIs Unity compiles the kernels for. Preprocess only Sets Show compiled code to generate only the preprocessed code instead of the f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_408506ffb472
unity_docs
ui
Explain 'Drag-and-drop events' in Unity.
Drag events are sent during operations where visual elements have drag-and-drop behavior. This is an Editor-only event. To implement drag-and-drop functionality, make sure that visual elements register callbacks for specific events. Visual elements that support drag operations separate into two types: Draggable visual ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f54311d27fe9
unity_docs
animation
What is `Animator.CrossFade` in Unity? Explain its purpose and usage.
Animator.CrossFade Declaration public void CrossFade (string stateName , float normalizedTransitionDuration , int layer = -1, float normalizedTimeOffset = float.NegativeInfinity, float normalizedTransitionTime = 0.0f); Declaration public void CrossFade (int stateHashName , float normalizedTransitionDu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2b4d206127e
unity_docs
scripting
What is `ChangeGameObjectParentEventArgs.instanceId` in Unity? Explain its purpose and usage.
ChangeGameObjectParentEventArgs.instanceId public int instanceId ; Description The instance ID of the GameObject whose parent changed. Note that this is not the instance ID of the Transform component.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ab2f5595925
unity_docs
physics
What is `TerrainTools.TerrainPaintUtility.EndPaintHeightmap` in Unity? Explain its purpose and usage.
TerrainPaintUtility.EndPaintHeightmap Declaration public static void EndPaintHeightmap ( TerrainTools.PaintContext ctx , string editorUndoName ); Parameters Parameter Description ctx The heightmap paint context to complete. editorUndoName Unique name used for the undo stack. Description Helper function...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c49098e80ab2
unity_docs
scripting
Show me a Unity C# example demonstrating `SystemInfo.batteryLevel`.
SystemInfo.batteryLevel public static float batteryLevel ; Description The current battery level (Read Only). The current level of the battery, represented as a float between 0 and 1 . If the battery level is not available on your target platform, this property returns -1 . ```csharp using UnityEngine;...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4ca88f7855df
unity_docs
editor
Explain 'Assign assets to an AssetBundle' in Unity.
To build assets into an AssetBundle, you must first assign assets to an AssetBundle, either in the Unity Editor or through a script. You can then create and use a script to build the AssetBundles. For information on the best approaches for organizing assets into AssetBundles, refer to Organizing assets into AssetBundle...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4f893ea442e0
github
scripting
Write a Unity C# script called UI Manager
```csharp using System.Collections.Generic; using Solid.Core; using UnityEngine; /*Copyright (c) Created by Oleksii Volovich 2021*/ namespace Solid.UI { public sealed class UIManager { private readonly Canvas _canvas; private List<PopUp> _popUps; public UIManager(Canvas canvas) ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_3cfa5a338242
unity_docs
scripting
What is `UIElements.ConverterGroup.description` in Unity? Explain its purpose and usage.
ConverterGroup.description public string description ; Description Optional description for a converter group ID that may include information about what this group contains or is used for, to be displayed to users to assist while authoring.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7798a949ed05
unity_docs
rendering
In Unity's 'Grass and other details', what is 'Use GPU Instancing' and how does it work?
You can specify if you want to use GPU instancing to render your detail meshes. With GPU instancing, Unity uses the material and the shader specified on the prefab for rendering. This lets you perform more customization in the shader and use Shader Graph . Unity still applies the Width and Height noise to each instance...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4afa770d3d63
unity_docs
xr
Show me a Unity code example for 'Notarize with Xcode and command-line tools'.
p at Apple Developer . ## Compress the application Apple requires that you compress your application before you upload it for notarization. To do this, use the following steps: Open Terminal and navigate to the directory the application is in. Run the following command where: "application_name.app" is your built appl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3cb429692da9
unity_docs
scripting
Give me an overview of the `AudioListener` class in Unity.
AudioListener class in UnityEngine / Inherits from: Behaviour / Implemented in: UnityEngine.AudioModule Description Representation of a listener in 3D space. This class implements a microphone-like device. It records the sounds around it and plays that through the player's speakers. You can only have one lis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_94dd30945a8e
github
scripting
Write a Unity C# UI script for Chat Controller
```csharp using UnityEngine; using UnityEngine.UI; using TMPro; public class ChatController : MonoBehaviour { public TMP_InputField ChatInputField; public TMP_Text ChatDisplayOutput; public Scrollbar ChatScrollbar; void OnEnable() { ChatInputField.onSubmit.AddListener(AddToChatOutput)...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_9ad92cd91691
unity_docs
physics
Show me a Unity C# example demonstrating `Physics.bounceThreshold`.
Physics.bounceThreshold public static float bounceThreshold ; Description Two colliding objects with a relative velocity below this will not bounce (default 2). Must be positive. This value is usually changed in Edit->Project Settings->Physics inspector instead of from scripts. ```csharp using UnityEngine;pu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6246211da718
unity_docs
rendering
What is `TextureImporterSettings.streamingMipmapsPriority` in Unity? Explain its purpose and usage.
TextureImporterSettings.streamingMipmapsPriority public int streamingMipmapsPriority ; Description Relative priority for this texture when reducing memory size in order to hit the memory budget. When mipmap streaming is enabled, Unity will automatically reduce the size of textures until they fit into the textur...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_936c9d70cdb1
unity_docs
editor
What is `AssetDatabase.SetImporterOverride` in Unity? Explain its purpose and usage.
AssetDatabase.SetImporterOverride Declaration public static void SetImporterOverride (string path ); Parameters Parameter Description path Project relative path for the asset. Description Sets a specific importer to use for the asset. Multiple Importers may be registered to a single asset by using either ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8c5600f70a8e
unity_docs
scripting
What is `Unity.Hierarchy.HierarchyNodeTypeHandlerBase.SearchBegin` in Unity? Explain its purpose and usage.
HierarchyNodeTypeHandlerBase.SearchBegin Declaration protected void SearchBegin ( Unity.Hierarchy.HierarchySearchQueryDescriptor query ); Parameters Parameter Description query The search query descriptor. Description Called when a new search query begins.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d4736bd5d7ad
unity_docs
scripting
Explain 'Change the layout of an overlay' in Unity.
You can set an overlay to display in one of the following layouts: Panel : Displays all the overlay’s content and its label. You can’t set overlays that are docked to the edges of the Scene view to Panel. Horizontal : Displays the overlay’s content in a horizontal container. An overlay set to the Horizontal layout does...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6507ba39ac60
unity_docs
animation
What is `Animations.AnimatorJobExtensions.ResolveAllSceneHandles` in Unity? Explain its purpose and usage.
AnimatorJobExtensions.ResolveAllSceneHandles Declaration public static void ResolveAllSceneHandles ( Animator animator ); Parameters Parameter Description animator The Animator instance that calls this method. Description Newly created handles are always resolved lazily on the next access when the jobs ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dde07733268a
unity_docs
rendering
Explain 'Render Texture Inspector window reference' in Unity.
The Render Texture inspector is similar to the Texture Inspector . The Render Texture inspector displays the current contents of Render Texture in real-time and can be an invaluable debugging tool for effects that use render textures. Property Description Dimension Set the number of dimensions of the Render Texture. Fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f6139faf2fc2
unity_docs
rendering
Explain 'Lightmap Parameters Asset Inspector window reference' in Unity.
## Properties When you click on a Lightmap Parameters Asset in the Project window , the Inspector window displays the values defined in that Asset. The parameters and their descriptions are listed in the table below. ## Realtime GI These parameters configure Enlighten Realtime Global Illumination . See render pipeli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b56ca4bf5468
unity_docs
animation
What is `AnimationMode` in Unity? Explain its purpose and usage.
AnimationMode class in UnityEditor Description AnimationMode is used by the AnimationWindow to store properties modified by the AnimationClip playback. When exiting AnimationMode all properties are reverted to their default state. Animated properties are also highlighted by the inspector. Use StartAnim...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_77cacce4963a
unity_docs
scripting
In Unity's 'Create prefabs', what is 'Create a prefab asset' and how does it work?
To create a prefab asset, perform the following steps: Create a GameObject and configure its position, scale, rotation, components, and other properties as needed. Drag the GameObject into the Assets folder in the Project window . You can optionally select more than one GameObject to create multiple prefab assets. Unit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f7c659292e36
unity_docs
physics
What is `PhysicsVisualizationSettings.SetShowArticulationBodies` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.SetShowArticulationBodies Declaration public static void SetShowArticulationBodies (bool show ); Parameters Parameter Description show Value to set. Description Should Articulation Bodies be shown by the Physics Visualizer. Sleeping Articulation Bodies can be further filtered ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_affc05d8629d
unity_docs
scripting
In Unity's 'Programming with the Asset Database', what is 'Accessing sub-assets' and how does it work?
Asset files can contain multiple serialized objects, each of which can be considered an asset for the purposes of scripting with the AssetDatabase class. For example, a . prefab asset file could contain a serialized GameObject with multiple components attached. Each of those components are also serialized as objects in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_35fd890b15d6
unity_docs
rendering
Show me a Unity code example for 'Reflections shader example in the Built-In Render Pipeline'.
Cubemap texture; we will extend the world-space normals shader above to look into it. The code is starting to get a bit involved by now. Of course, if you want shaders that automatically work with lights, shadows, reflections and the rest of the lighting system, it’s way easier to use surface shaders . This example is ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7d5d792ca90c
unity_docs
physics
What is `Compilation.CompilationPipeline.codeOptimizationChanged` in Unity? Explain its purpose and usage.
CompilationPipeline.codeOptimizationChanged Parameters Parameter Description value Current code optimization mode value. Description This event triggers whenever the codeOptimization property changes between Debug and Release modes.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c8d31536b84
unity_docs
scripting
What is `Caching.ClearCachedVersion` in Unity? Explain its purpose and usage.
Caching.ClearCachedVersion Declaration public static bool ClearCachedVersion (string assetBundleName , Hash128 hash ); Parameters Parameter Description assetBundleName The AssetBundle name. hash Version needs to be cleaned. Returns bool Returns true when cache clearing succeeded. Can return false if...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20d85453c077
unity_docs
scripting
Show me a Unity C# example demonstrating `Keyframe.outTangent`.
rame.outTangent public float outTangent ; Description Sets the outgoing tangent for this key. The outgoing tangent affects the slope of the curve from this key to the next key. The outgoing tangent matches the outgoing slope of the curve. A positive value for inTangent results in an upward tangent, while a ne...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_93d061b4f85e
unity_docs
scripting
In Unity's 'Get started with runtime UI', what is 'Set up the scene' and how does it work?
Create a UIDocument GameObject in the SampleScene and add the UI Document as the source asset. In the SampleScene, select GameObject > UI Toolkit > UI Document . This creates the following: A UI Toolkit folder with a Panel Settings asset and a default runtime theme. A GameObject with a UI Document component attached, a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_be7147b9b5ec
github
scripting
Write a Unity C# ScriptableObject for Factory Process Slot Definition
```csharp using FactoryMustScale.Simulation; using UnityEngine; namespace FactoryMustScale.Authoring { [System.Serializable] public struct FactoryProcessSlotDefinition { public CardinalDirectionMask Directions; public int ItemIdFilter; public int MaxItemsPerTick; } [System....
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_38da43e1bfe3
unity_docs
performance
What are the parameters of `Hash128.Append` in Unity?
Description Hash new input data and combine with the current hash value. The value must be an "unmanaged" C# type. Primitive types like int, float, bool, enums, pointers, or structs containing primitive types are all unmanaged types. See Unmanaged types in C# language reference. The int and float overloads use a dedica...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ebe6cac7e481
unity_docs
scripting
What is `MPE.ChannelClient.GetChannelClientList` in Unity? Explain its purpose and usage.
ChannelClient.GetChannelClientList Declaration public static ChannelClientInfo[] GetChannelClientList (); Returns ChannelClientInfo[] A list of ChannelClientInfo for all clients. Description Gets information for all ChannelClient s running on a single instance of Unity.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_104d2be1b66e
unity_docs
editor
In Unity's 'Log files reference', what is 'macOS' and how does it work?
On macOS, you can also access Unity’s logs via the Console.app utility Log type Log location Editor ~/Library/Logs/Unity/Editor.log Package manager ~/Library/Logs/Unity/upm.log Licensing client ~/Library/Logs/Unity/Unity.Licensing.Client.log Licensing audits ~/Library/Logs/Unity/Unity.Entitlements.Audit.log
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_50fbe88db33b
unity_docs
ui
What is `Overlays.Overlay.Close` in Unity? Explain its purpose and usage.
Overlay.Close Declaration public void Close (); Description Remove the Overlay from its OverlayCanvas . Note that this does not remove an Overlay from the Overlay Menu if it is registered with OverlayAttribute .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_29b25407fa52
unity_docs
scripting
Explain 'MaskField' in Unity.
The MaskField is an Editor-only control that lets users select one or more options from a list of options. Note : To align an element with other fields in an Inspector window, simply apply the.unity-base-field__aligned USS class to it. For more information, refer to BaseField . ## Create a MaskField You can create a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cf9e5fe9d29d
unity_docs
rendering
In Unity's 'On-demand resources', what is 'Create an AssetBundle' and how does it work?
To create an AssetBundle, use the following steps: Create a new folder to group the Assets you want to place into an AssetBundle. To do this, right-click inside the Assets folder in the Project window and go to Create > Folder . Give the new folder a name. Select the Asset files you want to add to the AssetBundle, then...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_63bebe7cafac
unity_docs
scripting
What is `PlayerSettings.GetSupportedIconKinds` in Unity? Explain its purpose and usage.
PlayerSettings.GetSupportedIconKinds Declaration public static PlatformIconKind[] GetSupportedIconKinds ( Build.NamedBuildTarget buildTarget ); Parameters Parameter Description buildTarget The NamedBuildTarget . Description Retrieves all PlatformIconKind values supported by the specified build target....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5f274a6fdbdf
unity_docs
scripting
What are the parameters of `Debug.LogError` in Unity?
Description A variant of Debug.Log that logs an error message to the console. When you select the message in the Editor's console, the context object to which the message applies is highlighted in the Hierarchy window. You can click the hyperlinks in the stack trace to go directly to the relevant lines of code in your ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c9ff9c7f2c9
unity_docs
editor
What is `VersionControl.VersionControlObject.OnActivate` in Unity? Explain its purpose and usage.
VersionControlObject.OnActivate Declaration public void OnActivate (); Description Called when your version control system is activated. This happens when user selects new VCS from Version Control settings window, when it gets activated from script, or during Unity startup. Unity calls this method to inform you...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a05a3db73c5b
unity_docs
editor
Show me a Unity C# example demonstrating `Profiling.FrameDataView.GetMarkers`.
FrameDataView.GetMarkers Declaration public void GetMarkers (List<MarkerInfo> markerInfoList ); Parameters Parameter Description markerInfoList List filled with marker descriptors. Description Gets all available markers for the current profiling session. Use to retrieve all marker identifiers together wit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_96865ca0f329
unity_docs
scripting
Give me an overview of the `SkeletonBone` class in Unity.
SkeletonBone struct in UnityEngine / Implemented in: UnityEngine.AnimationModule Description Details of the Transform name mapped to the skeleton bone of a model and its default position and rotation in the T-pose. The skeleton models used in Unity have multiple bones. The SkeletonBone struct has properties t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_362ab199fb09_doc_1
github
scripting
What does `FetchOrders` do in this Unity script? Explain its purpose and signature.
Fetch orders from API Signature: ```csharp public void FetchOrders(Action<string> onSuccess, Action<string> onError) ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_f85c40a4d07b
unity_docs
editor
What are the parameters of `Undo.RegisterImporterUndo` in Unity?
Description Copies the state of the importer for the given asset path. This method is used to Undo a AssetDatabase.SetImporterOverride operation. ```csharp using UnityEditor; using UnityEngine; using UnityEditor.AssetImporters; using UnityEditor.Experimental;[ScriptedImporter(1, null, new[] {"fbx"})] class MyFBXImporte...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e41bd4d7e243
unity_docs
rendering
Show me a Unity C# example demonstrating `ImageConversion.EncodeNativeArrayToTGA`.
ompressed format. The encoded TGA data will be uncompressed 8bit grayscale, RGB or RGBA (depending on the passed in format). For single-channel red textures ( R8 , R16 , RFloat and RHalf ), the encoded TGA data will be in 8-bit grayscale. The native array that this function returns is allocated with the persis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_72fb2ca9c626
unity_docs
scripting
Show me a Unity C# example demonstrating `RenderMode.ScreenSpaceCamera`.
RenderMode.ScreenSpaceCamera Description Render using the Camera configured on the Canvas. ```csharp //Attach this script to your Canvas GameObjectusing UnityEngine;public class Example : MonoBehaviour { enum RenderModeStates { camera, overlay, world }; RenderModeStates m_RenderModeStates; Canvas m_Canvas; // U...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_758efd41c815
unity_docs
xr
In Unity's 'Request runtime permissions', what is 'Request permission at runtime' and how does it work?
The Android.Permission API provides functionality that you can use to check what permissions the application currently has and request permissions that the application requires but doesn’t have. An overview of the process to request permission at runtime is as follows: Check whether the user has already granted the app...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c29a00780151
unity_docs
math
What is `UIElements.Painter2D.QuadraticCurveTo` in Unity? Explain its purpose and usage.
Painter2D.QuadraticCurveTo Declaration public void QuadraticCurveTo ( Vector2 p1 , Vector2 p2 ); Parameters Parameter Description p1 The control point of the quadratic bezier. p2 The final position of the quadratic bezier. Description Adds a quadratic bezier curve to the current sub-path to the prov...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6893eea44b6d
unity_docs
rendering
What is `ParticleSystem.ShapeModule.radiusSpread` in Unity? Explain its purpose and usage.
ParticleSystem.ShapeModule.radiusSpread public float radiusSpread ; Description Control the gap between particle emission points along the radius. Additional resources: ParticleSystem.ShapeModule.shapeType .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a3bafe31a530
unity_docs
scripting
What is `StaticOcclusionCullingVisualization.showPreVisualization` in Unity? Explain its purpose and usage.
StaticOcclusionCullingVisualization.showPreVisualization public static bool showPreVisualization ; Description If set to true, the visualization lines of the PVS volumes will show all cells rather than cells after culling.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_76ef6f232e7d
unity_docs
editor
Give me an overview of the `PrefabUnpackMode` class in Unity.
PrefabUnpackMode enumeration Description Enum used to determine how a Prefab should be unpacked. Additional resources: PrefabUtility.UnpackPrefabInstance . Properties Property Description OutermostRoot Use this mode to only unpack the outermost layer of a Prefab. Completely Use this to strip away all Prefab ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b0f03f26e63e
unity_docs
rendering
Show me a Unity code example for 'Import a file from the shader library in the Built-In Render Pipeline'.
Unity contains several files that can be used by your shader programs to bring in predefined variables and helper functions. This is done by the standard #include directive, e.g.: ``` SubShader { Pass { HLSLPROGRAM #include "UnityCG.cginc" ENDHLSL } } ``` Shader include files in Unity are with.cginc extension, a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_72e75217bfbf
unity_docs
physics
What is `Screen.mainWindowDisplayInfo` in Unity? Explain its purpose and usage.
Screen.mainWindowDisplayInfo public static DisplayInfo mainWindowDisplayInfo ; Description The display information associated with the display that the main application window is on. This API does not allocate managed memory outside of the Editor. You can access this property without generating garbage or tri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d6cae22880f
unity_docs
scripting
Give me an overview of the `AudioClip` class in Unity.
AudioClip class in UnityEngine / Inherits from: Audio.AudioResource / Implemented in: UnityEngine.AudioModule Description A container for audio data. An AudioClip stores the audio file either compressed as ogg vorbis or uncompressed. AudioClips are referenced and used by AudioSources to play sounds. Addition...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20333edbe4ce
unity_docs
audio
Give me an overview of the `AudioCurveRendering` class in Unity.
AudioCurveRendering class in UnityEditor Description Antialiased curve rendering functionality used by audio tools in the editor. Static Methods Method Description DrawCurve Renders a thin curve determined by the curve evaluation function. The solid color of the curve is set by the curveColor argument. DrawFi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e5f9d1a2d460
unity_docs
rendering
In Unity's '2D and 3D mode settings', what is 'In 2D Project mode:' and how does it work?
Any images you import are assumed to be 2D images ( Sprites ) and set to Sprite mode. The Scene View is set to 2D. The default game objects do not have real time, directional light. The camera ’s default position is at 0,0,–10. (It is 0,1,–10 in 3D Mode.) The camera is set to be Orthographic . (In 3D Mode it is Perspec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9d6a7ada2021
unity_docs
rendering
What is `UIElements.Cursor.texture` in Unity? Explain its purpose and usage.
Cursor.texture public Texture2D texture ; Description The texture to use for the cursor style. To use a texture as a cursor, import the texture with "Read/Write enabled" in the texture importer (or using the "Cursor" defaults).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ef4d7cfb2551
unity_docs
editor
What are the parameters of `iOS.Xcode.PBXProject.ReadFromFile` in Unity?
Description Reads the project from a file identified by the given path. Current contents of the project are discarded. ```csharp using UnityEditor; using System.IO; using UnityEditor.Callbacks; using UnityEditor.iOS.Xcode;public class Sample_ReadFromFile { [PostProcessBuild] public static void OnPostprocessBu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1afddfcd52be
unity_docs
rendering
In Unity's 'Generate lightmap UVs', what is 'How to provide your own lightmap UVs' and how does it work?
You can author your own lightmap UVs in the content creation software of your choice. Unity uses these UVs as input for its calculations. Where you put this data depends on whether you are providing UVs for baked lightmaps, real-time lightmaps, or both: For baked lightmaps, you must place lightmap UVs in the Mesh.uv2 ....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4e362b024b5f
unity_docs
scripting
What is `CharacterController.slopeLimit` in Unity? Explain its purpose and usage.
CharacterController.slopeLimit public float slopeLimit ; Description The character controllers slope limit in degrees. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Set the controller slope limit to 45 degrees CharacterController controller; void Start() { controller = GetComponent<...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1e477de28d96
unity_docs
animation
In Unity's 'Deterministic builds introduction', what is 'Build environment consistency' and how does it work?
The most common cause of non-deterministic builds are mismatched environments. To ensure a consistent environment consider the following: Consistent build machine environments: Keep operating system and CPU architecture consistent across all build machines. Floating-point rounding behavior differs between architectures...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aee9eb1b790a
unity_docs
animation
What is `Animations.PositionConstraint.AddSource` in Unity? Explain its purpose and usage.
PositionConstraint.AddSource Declaration public int AddSource ( Animations.ConstraintSource source ); Parameters Parameter Description source The source object and its weight. Returns int Returns the index of the added source. Description Adds a constraint source.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5e3249639a42
unity_docs
input
What is `Experimental.GraphView.SelectionDragger.OnMouseMove` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. SelectionDragger.OnMouseMove Declaration protected void OnMouseMove ( UIElements.MouseMoveEvent e ); Parameters Parameter Description e The event. Description Called on mouse move event.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a92591b1bbe2
unity_docs
ui
Show me a Unity code example for 'Migrate from Immediate Mode GUI (IMGUI) to UI Toolkit'.
ble frame. The body of OnGUI() might contain many conditions and different states. UI Toolkit operates in an event-driven system. You define the look of the UI in its default state and define the behaviors of the UI in response to events. Any changes you make in UI Toolkit cause persistent changes to the state of your ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3a4dac5eef83
unity_docs
scripting
What is `Experimental.GraphView.EdgeManipulator.OnPointerUp` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeManipulator.OnPointerUp Declaration protected void OnPointerUp ( UIElements.PointerUpEvent evt ); Parameters Parameter Description evt The pointer up event. Description Called when a pointer up event occurs.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f2be36c5279f
unity_docs
animation
What is `Animations.CurveFilterOptions.scaleError` in Unity? Explain its purpose and usage.
CurveFilterOptions.scaleError public float scaleError ; Description The amount the scale animation curve is allowed to deviate from its original curve. This amount is expressed as a percentage: a positive value between 0 and 100.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4a844e37c1ce
unity_docs
ui
In Unity's 'RadioButtonGroup', what is 'Create a RadioButtonGroup' and how does it work?
You can create a RadioButtonGroup with UI Builder, UXML, or C#. UI BUilder In UI Builder, you can add options to a RadioButtonGroup by entering the choices you want separated by commas in the Choices field located within the Inspector panel of the RadioButtonGroup. To set the default value, in the Inspector of the Radi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_62b30bc1c428
unity_docs
rendering
What is `Rendering.VertexAttribute` in Unity? Explain its purpose and usage.
VertexAttribute enumeration Description Possible attribute types that describe a vertex in a Mesh. Mesh vertex data comprised of different Vertex Attributes. For example, a vertex can include a Position, Normal, TexCoord0 and Color. Not all Meshes have all possible VertexAttributes. You can use this enum to query...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d8fdf8b9ce92
unity_docs
scripting
What is `SystemInfo.supportsStoreAndResolveAction` in Unity? Explain its purpose and usage.
SystemInfo.supportsStoreAndResolveAction public static bool supportsStoreAndResolveAction ; Description This property is true if the graphics API of the target build platform takes RenderBufferStoreAction.StoreAndResolve into account, false if otherwise. Use this property to check if RenderBufferStoreAction....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ec9abdcbe158
unity_docs
scripting
What is `Rendering.RenderPipelineGlobalSettings.GetSettingsImplementingInterface` in Unity? Explain its purpose and usage.
RenderPipelineGlobalSettings.GetSettingsImplementingInterface Declaration protected bool GetSettingsImplementingInterface (out List<TSettingsInterfaceType> settings ); Parameters Parameter Description settings A list of settings of type TSettingsInterfaceType . If none were found, the list is empty. Return...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cf967d2e2f65
unity_docs
ui
What is `UIElements.VisualElementExtensions.ChangeCoordinatesTo` in Unity? Explain its purpose and usage.
VisualElementExtensions.ChangeCoordinatesTo Declaration public static Vector2 ChangeCoordinatesTo ( UIElements.VisualElement src , UIElements.VisualElement dest , Vector2 point ); Parameters Parameter Description src The element to use as a reference as the source local space. dest The element to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b19d96ceefdc
unity_docs
scripting
In Unity's 'Write and run coroutines', what is 'Resuming coroutines' and how does it work?
When a suspended coroutine resumes execution depends on the yield instruction provided in the yield return statement. A yield return null resumes on the next frame. Unity has a set of custom yield instructions that you can use to resume after a specified time, when a specified conditions is met, or at specific points i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d3ba0a42d892
unity_docs
scripting
Explain 'RepeatButton' in Unity.
A RepeatButton performs a repetitive action when users press and hold it. You define the action, a delay, and an interval. When users press the RepeatButton, the initial delay must be met before the first action starts, and then it repeats at the specified interval. Note : A RepeatButton doesn’t have the same styling a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b98011528e75
unity_docs
editor
What are the parameters of `PrefabUtility.InstantiatePrefab` in Unity?
Returns Object The GameObject at the root of the Prefab. Description Instantiates the given Prefab in a given Scene. This is similar to Instantiate but creates a Prefab connection to the Prefab. If you do not specify a Scene handle, the Prefab is instantiated in the active Scene. Note: You should not instantiate Prefab...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5954b2a2d627
unity_docs
scripting
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetrics.GetMetrics` in Unity? Explain its purpose and usage.
AsyncReadManagerMetrics.GetMetrics Declaration public static AsyncReadManagerRequestMetric[] GetMetrics ( Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetrics.Flags flags ); Declaration public static AsyncReadManagerRequestMetric[] GetMetrics ( Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetricsFilters filters , U...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab625a69360d
unity_docs
scripting
What is `Graphics.minOpenGLESVersion` in Unity? Explain its purpose and usage.
Graphics.minOpenGLESVersion public static Rendering.OpenGLESVersion minOpenGLESVersion ; Description The minimum OpenGL ES version. The value is specified in PlayerSettings . Additional resources: PlayerSettings.GetGraphicsAPIs , PlayerSettings.openGLRequireES31 , PlayerSettings.openGLRequireES31AEP , Pl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ade595ad9cb0
unity_docs
animation
What is `Animations.RotationConstraint.GetSources` in Unity? Explain its purpose and usage.
RotationConstraint.GetSources Declaration public void GetSources (List<ConstraintSource> sources ); Parameters Parameter Description sources The list of sources to be filled by the component. Description Gets the list of sources. 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_sr_b9f118c72c04
unity_docs
editor
What are the parameters of `AssetImporters.ScriptedImporter.GatherDependenciesFromSourceFile` in Unity?
Returns void A string array containing paths to the assets that you want create dependencies on for the asset currently being processed by this method. Description A static callback that you can implement to set up artifact dependencies to other Assets, and optimize the order your assets are imported. If you implement ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d0cbfc9acaa6
unity_docs
animation
Explain 'Avatar Mask window reference' in Unity.
There are two ways to define which parts of your animation should be masked: By selecting from a Humanoid body map By choosing which bones to include or exclude from a Transform hierarchy ## Humanoid body selection If your animation uses a Humanoid Avatar , you can select or deselect portions of the simplified humano...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_722ce4a7aaf5
unity_docs
scripting
Explain 'The GameActivity application entry point' in Unity.
The GameActivity application entry point is an extension of the Activity application entry point and is the default application entry point for new Unity projects. It provides more control over the interaction between Android and your application than the Activity application entry point. To provide this control, the G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cb2478dec8e4
unity_docs
audio
Give me an overview of the `AudioVelocityUpdateMode` class in Unity.
AudioVelocityUpdateMode enumeration Description Describes when an AudioSource or AudioListener is updated. Properties Property Description Auto Updates the source or listener in the FixedUpdate loop if it is attached to a Rigidbody, dynamic Update otherwise. Fixed Updates the source or listener in the Fixe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a33b6b1edff7
unity_docs
scripting
Explain 'Format of text serialized files' in Unity.
Unity’s Scene format uses a custom subset of the YAML data serialization language. YAML is an open format with documentation about it available on the YAML website . For more information about the YAML used in unity, read the documentation on UnityYAML . The file writes each Object in a Scene as a separate YAML documen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9802a30ce6b6
unity_docs
scripting
What is `Transform.SetParent` in Unity? Explain its purpose and usage.
Transform.SetParent Declaration public void SetParent ( Transform p ); Declaration public void SetParent ( Transform parent , bool worldPositionStays ); Parameters Parameter Description parent The parent Transform to use. worldPositionStays If true, the parent-relative position, scale and rotation...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ffcc48a751ac
unity_docs
rendering
What is `LightTransport.IProbeIntegrator.Result.ctor` in Unity? Explain its purpose and usage.
IProbeIntegrator.Result Constructor Declaration public IProbeIntegrator.Result ( LightTransport.IProbeIntegrator.ResultType _type , string _message ); Parameters Parameter Description _type Result type. _message Message with detailed error information. Description Construct a new Result object.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_3d13c89661d4_doc_9
github
scripting
What does `GetValueFromIndex` do in this Unity script? Explain its purpose and signature.
Gets the value of the entry at the specified index.Zero-based index of entry in ordered dictionary.The key.If is out of range. Signature: ```csharp public object GetValueFromIndex(int index) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_30f19496ff24
unity_docs
physics
Give me an overview of the `ClothSphereColliderPair` class in Unity.
ClothSphereColliderPair struct in UnityEngine / Implemented in: UnityEngine.ClothModule Description A pair of SphereColliders used to define shapes for Cloth objects to collide against. A ClothSphereColliderPair can contain either a single valid SphereCollider instance (with the second one being null), or a pai...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_01f97c793b68
unity_docs
scripting
In Unity's 'How code stripping affects content', what is 'Preventing stripping of types used in Addressables' and how does it work?
If a type of Unity object is present in content built with Addressables , but not in any scene or asset built into the Player, then Unity might strip that type. Addressables automatically generates a link.xml file inside the Library/com.unity.addressables folder describing types used in the content. The Player build ta...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a2c4ec879d3d
unity_docs
rendering
In Unity's 'Lighting window reference', what is 'Lighting window layout' and how does it work?
The Lighting window contains the following elements: The Scene tab The Adaptive Probe Volumes tab - Universal Render Pipeline (URP) and High-Definition Render Pipeline (HDRP) only The Environment tab The Realtime Lightmaps tab The Baked Lightmaps tab The control area , at the bottom of the window
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.