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_d0c1e90b8a40
unity_docs
rendering
What is `ParticleSystemAnimationType` in Unity? Explain its purpose and usage.
ParticleSystemAnimationType enumeration Description The animation type. Controls how texture sheet animations play. Additional resources: ParticleSystem.textureSheetAnimation.type. Properties Property Description WholeSheet Animate over the whole texture sheet from left to right, top to bottom. SingleRow Anim...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_df1c8f1c9254
unity_docs
rendering
Show me a Unity C# example demonstrating `LightTransport.IProbeIntegrator.IntegrateOcclusion`.
s between 0-1: Partial occlusion. Value 0.0: Full occlusion (light is completely blocked). The light indices can be precomputed using InputExtraction.ComputeOcclusionLightIndicesFromBakeInput to select the most influential lights for each probe position. Additional resources: InputExtraction.ComputeOcclusionLightI...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_afaa83aa03d2
unity_docs
editor
What is `Progress.ShowDetails` in Unity? Explain its purpose and usage.
Progress.ShowDetails Declaration public static void ShowDetails (bool shouldReposition ); Parameters Parameter Description shouldReposition To place the window in the bottom right corner of the main Editor window, pass True. To restore the last window position, pass False. Description Opens the progress wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fa8477553d61
unity_docs
math
What is `AndroidJNI.SetLongArrayElement` in Unity? Explain its purpose and usage.
AndroidJNI.SetLongArrayElement Declaration public static void SetLongArrayElement (IntPtr array , int index , long val ); Description Sets the long value of one element in a primitive array. This function is a special case of SetLongArrayRegion(), called with region size set to 1. Additional resources: Java...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f7e16902f20
unity_docs
rendering
What is `LightmapParameters.directLightQuality` in Unity? Explain its purpose and usage.
LightmapParameters.directLightQuality public int directLightQuality ; Description The number of rays used for lights with an area. Allows for accurate soft shadowing. This is the maximum number of rays to trace to any light with an area. Larger lights will require more rays to produce a noise-free output. The ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c4442f832c96
unity_docs
ui
Explain 'The Toolbar' in Unity.
You can find the toolbar at the top of the Editor. The toolbar is not a window and it is the only part of the Editor interface that you can’t rearrange. For additional tools in the Scene view , refer to Overlays . Property Description Unity Account Access your Unity Account from the Account dropdown menu. Asset Store G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b63de30ea028
unity_docs
scripting
Give me an overview of the `ILogHandler` class in Unity.
ILogHandler interface in UnityEngine Description Interface for custom log handler implementation. ILogHandler interface to ease unit-testing and mocking of loggers. ```csharp using UnityEngine; using System.Collections; using System.IO; using System;public class MyFileLogHandler : ILogHandler { private FileStre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d8ae52bcbfe7
unity_docs
rendering
Show me a Unity C# example demonstrating `LightTransport.RadeonRaysContext.CreateBuffer`.
RadeonRaysContext.CreateBuffer Declaration public LightTransport.BufferID CreateBuffer (ulong count , ulong stride ); Parameters Parameter Description count Number of elements in the buffer. stride Stride of the buffer in bytes. Returns BufferID ID of the newly created buffer. Description Create...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f548eeba8229
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.importPackageStarted`.
AssetDatabase.importPackageStarted Parameters Parameter Description value Name of package. Description Callback raised whenever a package import starts. ```csharp using UnityEditor; using UnityEngine;[InitializeOnLoad] public class AssetDatabaseExamples { static AssetDatabaseExamples() { AssetDatabase.impor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_847afc3c30d2
unity_docs
editor
In Unity's 'Additional files for Roslyn analyzers and source generators', what is 'Additional file filtering' and how does it work?
Each compiled assembly receives a list of additional files based on the analyzers running for that assembly definition , filtered by the [Analyzer Name] . For example, consider a project with the following assemblies and analyzers: Assembly1 uses an analyzer named Analyzer1 Assembly2 uses an analyzer named Analyzer2 As...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3f0f5d7e6622
unity_docs
math
Explain 'Serialization rules' in Unity.
Unity uses its own serialization system, which is specifically designed to operate efficiently at runtime. Because of this, serialization in Unity behaves differently to serialization in other programming environments. Unity supports the standard .NET/C# [Serializable] and [NonSerialized] attributes, but their behavior...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b7d19b569241
unity_docs
ui
What is `Experimental.GraphView.Dragger` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Dragger class in UnityEditor.Experimental.GraphView / Inherits from: UIElements.MouseManipulator Description Base manipulator for mouse-dragging elements. Properties Property Description clampToParentEdges If true, it doe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a95fb84d261
unity_docs
scripting
What is `AudioReverbZone` in Unity? Explain its purpose and usage.
AudioReverbZone class in UnityEngine / Inherits from: Behaviour / Implemented in: UnityEngine.AudioModule Description Reverb Zones are used when you want to create location based ambient effects in the Scene. As the Audio Listener moves into a Reverb Zone, the ambient effect associated with the zone is gradu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b1e84257757d
unity_docs
rendering
What is `GUILayout.Window` in Unity? Explain its purpose and usage.
GUILayout.Window Declaration public static Rect Window (int id , Rect screenRect , GUI.WindowFunction func , string text , params GUILayoutOption[] options ); Declaration public static Rect Window (int id , Rect screenRect , GUI.WindowFunction func , Texture image , params GUILayoutOption[...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e055f9b03efd
unity_docs
scripting
What is `AssetBundle.LoadFromFileAsync` in Unity? Explain its purpose and usage.
AssetBundle.LoadFromFileAsync Declaration public static AssetBundleCreateRequest LoadFromFileAsync (string path ); Declaration public static AssetBundleCreateRequest LoadFromFileAsync (string path , uint crc ); Declaration public static AssetBundleCreateRequest LoadFromFileAsync (string path , uint...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fd6aeb5e4bee
unity_docs
physics
What is `TreeMotionVectorModeOverride` in Unity? Explain its purpose and usage.
TreeMotionVectorModeOverride enumeration Description Options for motion vector rendering on the terrain. Properties Property Description CameraMotionOnly Use only camera movement to track motion for all SpeedTree models painted on the terrain. PerObjectMotion Use a specific pass to track motion for all SpeedTr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_5242dfca4b88_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Creates test assets BEFORE entering Play Mode (but still part of the test pipeline),and cleans them up afterward. Signature: ```csharp public static class AssetSetup ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
gh_8afa13e1efe8_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Author: Cameron ReuschelThe class holding all extension methods specific to colors in the core library. Signature: ```csharp public static class ColorExtensions ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_a4a73af283d2
unity_docs
scripting
What is `XR.MeshGenerationResult.Mesh` in Unity? Explain its purpose and usage.
MeshGenerationResult.Mesh public Mesh Mesh ; Description If the generation was successful, data has been written to this Mesh . Check MeshGenerationResult.Status to determine if the generation was successful.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c5a9eea094f3
unity_docs
rendering
What is `TextureFormat.R8_SIGNED` in Unity? Explain its purpose and usage.
TextureFormat.R8_SIGNED Description Single channel (R) texture format, 8-bits signed integer. Import textures of this format in .DDS files. Note that not all graphics cards support all texture formats, use SystemInfo.SupportsTextureFormat to check. Additional resources: Texture2D.format , texture assets .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_533ada7bbb8d
unity_docs
ui
In Unity's 'IMGUIContainer', what is 'Create an IMGUIContainer' and how does it work?
You can create an IMGUIContainer with UXML or C#. Assume you have an IMGUI code snippet like the following: ```csharp void IMGUICode() { GUILayout.BeginArea(new Rect(0, 0, 100, 100)); GUILayout.Button("Hello World"); GUILayout.EndArea(); } ``` You can create an IMGUIContainer with the following: UXML ``` <IMGUIConta...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd9eb804ff3b
unity_docs
math
What is `Mesh.vertices` in Unity? Explain its purpose and usage.
Mesh.vertices public Vector3[] vertices ; Description Returns a copy of the vertex positions or assigns a new vertex positions array. The number of vertices in the Mesh is changed by assigning a vertex array with a different number of vertices. If you resize the vertex array then all other vertex attributes (n...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b5af2eb3ac53
unity_docs
editor
Show me a Unity C# example demonstrating `VersionControl.Provider.Merge`.
set in the External Tools section of the Preferences window, on the conflicting Assets. When the merge task finishes, the AssetList only contains the Assets that the tool could merge. To correctly resolve the resulting AssetList states (and replace the files with the correct, merged version), you must call a subse...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1aae7a8d896
unity_docs
physics
What is `CharacterJoint.highTwistLimit` in Unity? Explain its purpose and usage.
CharacterJoint.highTwistLimit public SoftJointLimit highTwistLimit ; Description The upper limit around the primary axis of the character joint. The limit is relative to the angle the two rigidbodies started the simulation out with.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_653cf4b60768
unity_docs
audio
Give me an overview of the `GamepadSpeakerOutputType` class in Unity.
GamepadSpeakerOutputType enumeration Description Gamepad audio output types. This API is only for PlayStation 4 and PlayStation 5 platforms. Enclose this API with the UNITY_EDITOR define for platforms other than PlayStation 4 and PlayStation 5. Properties Property Description Speaker Audio output is through th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_606788fc9601
unity_docs
rendering
What is `TextureImporterSettings.wrapMode` in Unity? Explain its purpose and usage.
TextureImporterSettings.wrapMode public TextureWrapMode wrapMode ; Description Texture coordinate wrapping mode. Using wrapMode sets the same wrapping mode on all axes. Different per-axis wrap modes can be set using wrapModeU , wrapModeV , wrapModeW . Querying the value returns the U axis wrap mode (same...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a0234a642576
unity_docs
editor
Show me a Unity code example for 'Set a layerMask'.
ou can use it in API calls that use a serialized layerMask property. ## Use a serialized layerMask property The simplest way to set a layermask in the Unity Editor is to create a property that uses Unity’s LayerMask class. If the property is public or uses the SerializeField attribute, Unity provides an interface in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_67697605a8e5
unity_docs
scripting
What are the parameters of `Search.PropertyDatabase.TryLoad` in Unity?
Returns bool True if the record is found and is valid, false otherwise. Description Loads a single property, already deseriazed into an object. ``` // Load the value already deserialized. var colorRecordKey = PropertyDatabase.CreateRecordKey("path/to/my/asset", "m_Color"); if (!propertyDatabase.TryLoad(colorRecordKey, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2691db79ae00
unity_docs
xr
Explain 'Introduction to packages' in Unity.
This section explains many of the concepts surrounding the Unity Package Manager functionality: Introduction to packages Versions Manifests Registry Package management Package sources Additional resources ## Versions Multiple versions of each package are available, marking changes to that package along its lifecycle....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_91b1bfab34db
unity_docs
input
What is `UIElements.PointerEventBase_1.pointerId` in Unity? Explain its purpose and usage.
PointerEventBase<T0>.pointerId public int pointerId ; Description Gets the identifier of the pointer that sent the event. If the mouse sends the event, the identifier is set to 0. If a touchscreen device sends the event, the identifier is set to the finger ID, which ranges from 1 to the number of touches t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5799f314ba1b
unity_docs
scripting
What is `UIElements.HelpBox` in Unity? Explain its purpose and usage.
HelpBox class in UnityEngine.UIElements / Inherits from: UIElements.VisualElement / Implemented in: UnityEngine.UIElementsModule Description Makes a help box with a message to the user. For more information, refer to UXML element HelpBox . ```csharp public class HelpBoxExample : EditorWindow { [MenuItem...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3d3b9908de3b
unity_docs
animation
In Unity's 'Animator Override Controller', what is 'Set up an Animator Override Controller asset' and how does it work?
Before you can use an Animator Override Controller asset, you must first create and define an Animator Controller asset. These steps begin with an already created and defined Animator Controller named NPC Animator . To extend an Animator Controller with an Animator Override Controller, follow these steps: Go to Assets ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_89f22e821969
unity_docs
ui
What is `UIElements.InspectorElement.FillDefaultInspector` in Unity? Explain its purpose and usage.
InspectorElement.FillDefaultInspector Declaration public static void FillDefaultInspector ( UIElements.VisualElement container , SerializedObject serializedObject , Editor editor ); Parameters Parameter Description container The parent VisualElement serializedObject The SerializedObject to inspect ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a7ed7dfac8cc
unity_docs
editor
What are the parameters of `iOS.Xcode.PBXProject.AddResourcesBuildPhase` in Unity?
Returns string Returns the GUID of the new phase. Description Creates a new resources build phase for a given target. If the resources build phase is already configured for a target, the function returns the existing phase. The new phase is placed at the end of the list of build phases configured for the target. ```csh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1deb78d2e54e
unity_docs
scripting
What are the parameters of `Video.VideoPlayer.errorReceived` in Unity?
Description The VideoPlayer uses this callback to report various types of errors. The types of errors the VideoPlayer reports include: HTTP connection problems. Issues finding the file. Unsupported file types. Permission issues. Runtime issues. This is useful if you want to log errors and debug so that it’s easier to d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b13041e2e377
unity_docs
editor
What is `Rendering.RenderPipelineEditorUtility.GetDerivedTypesSupportedOnCurrentPipeline` in Unity? Explain its purpose and usage.
RenderPipelineEditorUtility.GetDerivedTypesSupportedOnCurrentPipeline Declaration public static Type[] GetDerivedTypesSupportedOnCurrentPipeline (); Returns Type[] Child types of the base type supported on current pipeline. Description Returns the types that're children of T and have a SupportedOnRender...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a4773327b6a7
unity_docs
scripting
What is `Transform.SetAsLastSibling` in Unity? Explain its purpose and usage.
Transform.SetAsLastSibling Declaration public void SetAsLastSibling (); Description Move the transform to the end of the local transform list. ```csharp using UnityEngine; using System.Collections; using UnityEngine.UI; //Required when using UI Elements. using UnityEngine.EventSystems; // Required when using e...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0d8d29e5525a
unity_docs
editor
What is `MenuCommand` in Unity? Explain its purpose and usage.
MenuCommand class in UnityEditor Description Used to extract the context for a MenuItem . MenuCommand objects are passed to custom menu item functions defined using the MenuItem attribute. Note: The menu is added to the object and is accessible by right-clicking in the inspector. The script code requires th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28387aed3494
unity_docs
xr
What is `Editor.CreateCachedEditor` in Unity? Explain its purpose and usage.
Editor.CreateCachedEditor Declaration public static void CreateCachedEditor ( Object targetObject , Type editorType , ref Editor previousEditor ); Declaration public static void CreateCachedEditor (Object[] targetObjects , Type editorType , ref Editor previousEditor ); Parameters Parameter Descri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09e92c6384f9
unity_docs
rendering
What is `PickingIncludeExcludeList.IncludeRenderers` in Unity? Explain its purpose and usage.
PickingIncludeExcludeList.IncludeRenderers public NativeArray<int> IncludeRenderers ; Description An array of GameObjects that the picking algorithm exclusively considers when it selects the nearest object. If this is null, Unity considers all GameObjects in open scenes for selection.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2c232cf40d77
unity_docs
animation
What is `Animations.AnimatorController.RemoveParameter` in Unity? Explain its purpose and usage.
AnimatorController.RemoveParameter Declaration public void RemoveParameter (int index ); Parameters Parameter Description index The index of the AnimatorParameter. Description Utility function to remove a parameter from the controller. This function pushes an Undo operation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_102695999a80
unity_docs
physics
Show me a Unity code example for 'Build for QNX from the command line'.
ecutable for your preferred build host’s operating system. ## Command line arguments Prerequisites Make sure you’ve followed these instructions before building the project using the command line: Set up QNX_TARGET and QNX_HOST as per Install the Unity Editor for QNX . To instruct Unity to start in CLI mode and build ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_da9ab35162fb
unity_docs
editor
In Unity's 'Include additional files in a build', what is 'Accessing streaming assets' and how does it work?
The location of the StreamingAssets folder in your deployed application varies between platforms. To retrieve the path to the StreamingAssets folder reliably, use the Application.streamingAssetsPath property because it always points to the correct location on the current host platform. On most platforms Application.str...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af85802aa963
unity_docs
physics
What is `Rigidbody2D.SlideMovement.useAttachedTriggers` in Unity? Explain its purpose and usage.
Rigidbody2D.SlideMovement.useAttachedTriggers public bool useAttachedTriggers ; Description Can be used to select whether any Collider2D attached to this Rigidbody2D (that are configured as a trigger) are used to detect contacts. This is ignored if Rigidbody2D.SlideMovement.selectedCollider is selected. A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6dd3a3e8e299
unity_docs
xr
What is `Android.PermissionCallbacks.PermissionRequestDismissed` in Unity? Explain its purpose and usage.
PermissionCallbacks.PermissionRequestDismissed Parameters Parameter Description value Permission name. Description Triggered when the user dismisses the permission request without explicitly choosing any option. If you do not subscribe to this event, Unity triggers PermissionCallbacks.PermissionDenied as a f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_27ce0d6261a7
unity_docs
physics
What are the parameters of `AI.NavMeshBuilder.CollectSources` in Unity?
Description Collects renderers or physics colliders, and terrains within a volume. This function might not collect some MeshColliders that are at a distance greater than 1E7 from the origin. Declaration public static void CollectSources ( Bounds includedWorldBounds , int includedLayerMask , AI.NavMeshCollectGeometry ge...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1834771b5694
unity_docs
scripting
What is `Vector3.Set` in Unity? Explain its purpose and usage.
Vector3.Set Declaration public void Set (float newX , float newY , float newZ ); Description Set x, y and z components of an existing Vector3. ```csharp // Attach this script to a GameObject. Create an empty GameObject that will act as your "New Transform". Assign this in the Inspector. // Press the "Set" bu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8f97a4724c15
unity_docs
rendering
What is `ParticleSystemRenderer.freeformStretching` in Unity? Explain its purpose and usage.
ParticleSystemRenderer.freeformStretching public bool freeformStretching ; Description Enables freeform stretching behavior. With this stretching behavior particles don't get thin when viewed head-on and particle rotation can be independent from stretching direction. Additional resources: rotateWithStretchDire...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_14c22d647a3f
unity_docs
math
Show me a Unity C# example demonstrating `Matrix4x4.Scale`.
Matrix4x4.Scale Declaration public static Matrix4x4 Scale ( Vector3 vector ); Description Creates a scaling matrix. Returned matrix is such that scales along coordinate axes by a vector v . The matrix looks like this: ```csharp using UnityEngine;public class ExampleScript : MonoBehaviour { void Start() ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_081eafafe399
unity_docs
scripting
What is `Rendering.VirtualTexturing.GPUCacheSetting.sizeInMegaBytes` in Unity? Explain its purpose and usage.
Virtual Texturing is experimental and not ready for production use. The feature and documentation might be changed or removed in the future. GPUCacheSetting.sizeInMegaBytes public uint sizeInMegaBytes ; Description Size in MegaBytes of the cache created with these settings.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c7f8dd3ec67a
unity_docs
ui
What is `UIElements.MeshGenerationNode` in Unity? Explain its purpose and usage.
MeshGenerationNode struct in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description Contains a part of the draw sequence of a VisualElement. You can use it in a job to add nested draw calls. Public Methods Method Description DrawMesh Records a draw command with the provided tr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_974ce0a48b88
unity_docs
editor
What is `iOS.Xcode.PBXProject.GetCompileFlagsForFile` in Unity? Explain its purpose and usage.
PBXProject.GetCompileFlagsForFile Declaration public List<string> GetCompileFlagsForFile (string targetGuid , string fileGuid ); Parameters Parameter Description targetGuid The GUID of the target, such as the one returned by TargetGuidByName . fileGuid The GUID of the file. Returns List<string> The c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_135b7b0a9cfb
unity_docs
scripting
Explain 'The calculator' in Unity.
The Calculator search provider performs mathematical calculations that you can copy to the clipboard. You can also save the formula as a reusable search query, so it’s available to anyone in the project. For more information about mathematical expressions, refer to Use numeric field expressions . Note: You can’t implic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_77dfca5b4f93
unity_docs
rendering
Explain 'Memory Profiler module reference' in Unity.
The Memory Profiler module displays memory data in a chart at the top of the Profiler window . It displays a breakdown of where Unity allocated memory in each frame in the details pane in the lower half of the window. ## Chart categories The Memory Profiler module’s chart has categories that display detailed informat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e76879fa2aba
unity_docs
rendering
In Unity's 'Sample a 2D texture array in a shader', what is 'Example' and how does it work?
The following shader example samples a texture array using object space vertex positions as coordinates, and runs only on GPUs that support texture arrays. ``` Shader "Example/Sample2DArrayTexture" { Properties { // Create material properties for the 2D texture array and the slices to sample _MyArr ("Tex", 2DArray...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_95d2c5f9d59e
unity_docs
math
What is `ModifiableContactPair.SetPoint` in Unity? Explain its purpose and usage.
ModifiableContactPair.SetPoint Declaration public void SetPoint (int i , Vector3 v ); Parameters Parameter Description i Index of the contact point. v The location of a contact point. Description Set the location of a particular contact point in this contact pair.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_02445144a4e8
unity_docs
scripting
What is `UIElements.BaseTreeView.CollapseItem` in Unity? Explain its purpose and usage.
BaseTreeView.CollapseItem Declaration public void CollapseItem (int id , bool collapseAllChildren , bool refresh ); Parameters Parameter Description id The TreeView item identifier. collapseAllChildren When true, all children will also get collapsed. This is false by default. refresh Whether to refresh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e770e4ea46ee_doc_11
github
scripting
What does `DefaultSDKPath` do in this Unity script? Explain its purpose and signature.
Returns the default Magic Leap install path [HOME/MagicLeap/mlsdk/] Signature: ```csharp private static string DefaultSDKPath() ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_66bf3b2ed616
unity_docs
scripting
Explain 'Handle Game Controller input' in Unity.
The input scheme is dependent on the type of application you are developing. You can set up specific actions in Unity’s Input Manager settings. By default, the Unity Input Horizontal axis is mapped to the game controller D-pad and the left analog stick is mapped to extended profile controllers. See Input mapping for th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca0f5f6e713c
unity_docs
scripting
Give me an overview of the `AudioSettings` class in Unity.
AudioSettings class in UnityEngine / Implemented in: UnityEngine.AudioModule Description Controls the global audio settings from script. Setup speaker output and format. Static Properties Property Description audioSpatialExperience Determines if the Unity app's final mixed audio stream is spatialized. dri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_324e8b3cdf5b
unity_docs
editor
Explain 'Environment and tools' in Unity.
Configure your local environment and development tools for coding and testing in Unity and understand the .NET platform versions and components that Unity supports. Topic Description Integrated development environment (IDE) support Choose one of the major code editors with integrated support for Unity projects to use a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_afa9a64c5161
unity_docs
ui
Show me a Unity C# example demonstrating `GUI.UnfocusWindow`.
GUI.UnfocusWindow Declaration public static void UnfocusWindow (); Description Remove focus from all windows. Additional resources: GUI.FocusWindow . ```csharp // Draws 2 windows. When one button is clicked unfocus the window.using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b9aef9ac08b9
unity_docs
input
What is `Input.mousePosition` in Unity? Explain its purpose and usage.
Input.mousePosition public static Vector3 mousePosition ; Description The current mouse position in pixel coordinates. (Read Only). 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 System package....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b0ae128ec0e0
unity_docs
rendering
Explain 'Sample a texture in HLSL' in Unity.
To sample a texture in High-Level Shader Language (HLSL), declare a texture and its sampler. The sampler contains the properties the GPU uses to sample the texture, for example the wrap mode and filter mode. The properties usually come from the texture import settings . Note: If your project uses the Universal Render P...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2be6f7358ae8
unity_docs
rendering
What is `Renderer.probeAnchor` in Unity? Explain its purpose and usage.
Renderer.probeAnchor public Transform probeAnchor ; Description If set, Renderer will use this Transform's position to find the light or reflection probe. Otherwise the center of Renderer's AABB will be used.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ec79656a31ea
unity_docs
scripting
What is `Unity.Android.Gradle.GradlePlugin.Apply` in Unity? Explain its purpose and usage.
GradlePlugin.Apply public bool Apply ; Description The C# definition of the apply property. The apply statement with a boolean can be used to disable the default behavior of applying the plugin immediately (e.g. you want to apply it only in subprojects ).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d747ab96ddf8
unity_docs
scripting
What is `AndroidJNI.NewObjectA` in Unity? Explain its purpose and usage.
AndroidJNI.NewObjectA Declaration public static IntPtr NewObjectA (IntPtr clazz , IntPtr methodID , jvalue* args ); Description Constructs a new Java object. The method ID indicates which constructor method to invoke. This ID must be obtained by calling GetMethodID() with <init> as the method name and void (V...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_809289edc4d9
unity_docs
rendering
Show me a Unity code example for 'Add a subshader in a custom shader'.
ions. For information on how a Shader object works, and the relationship between Shader objects, SubShaders and Passes, see Shader objects introduction . In ShaderLab , you define a SubShader by placing a SubShader block inside a Shader block. ## Example This example code demonstrates the syntax for creating a Shader...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5ae7e3b8278c
unity_docs
xr
Show me a Unity C# example demonstrating `Search.SearchService.CreateContext`.
This search provider does not need to be active or registered). providerId Unique search provider ID string (i.e. asset, scene, find, etc.) providerIds List of search provider IDs. providers List of search providers. flags Options defining how the query is performed. Returns SearchContext Returns a new Sear...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e8361d2cbc46
unity_docs
xr
In Unity's 'Set up an Asset Store publisher profile', what is 'Create a Unity ID' and how does it work?
To create a Unity ID: Go to Create a Unity ID , or open the Unity Asset Store . Select the account icon. Select Create a Unity ID . Enter the required information. Use a publisher profile to create, submit, and gain revenue from your packages on the Asset Store. Before you do this read the Asset Store Provider Agreemen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8707336bb395
unity_docs
rendering
In Unity's 'Sprite Asset properties reference', what is 'Atlas & Material' and how does it work?
Property Description Sprite Atlas Graphics:** A utility that packs several sprite textures tightly together within a single texture known as an atlas. . 2D: A texture that is composed of several smaller textures. Also referred to as a texture atlas, image sprite, sprite sheet or packed texture. . ** A reference to the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_5cc1aa2c8246
github
scripting
Write a Unity C# UI script for TM Pro_Instruction Overlay
```csharp using UnityEngine; using System.Collections; namespace TMPro.Examples { public class TMPro_InstructionOverlay : MonoBehaviour { public enum FpsCounterAnchorPositions { TopLeft, BottomLeft, TopRight, BottomRight }; public FpsCounterAnchorPositions AnchorPosition = FpsCounterAn...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_67c05e1ed50e
unity_docs
scripting
What is `TerrainUtils.TerrainUtility` in Unity? Explain its purpose and usage.
TerrainUtility class in UnityEngine.TerrainUtils / Implemented in: UnityEngine.TerrainModule Description Provides a set of utility functions that are used by the terrain tools. Static Methods Method Description AutoConnect Automatically connects neighboring terrains.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0cd95d419c13
unity_docs
physics
In Unity's 'Character Controller component reference', what is 'Properties' and how does it work?
Property Description Slope Limit Limits the collider to only climb slopes that are less steep (in degrees) than the indicated value. Step Offset The character will step up a stair only if it is closer to the ground than the indicated value. This should not be greater than the Character Controller’s height or it will ge...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6532ae0d616f
unity_docs
rendering
Show me a Unity code example for 'Add an HLSL shader program'.
To add a High-Level Shader Language (HLSL) program to a shader file , add the code to the Pass block. Wrap the code in HLSLPROGRAM and ENDHLSL macros. For example: ``` Shader "Examples/ExampleShader" { SubShader { Pass { Name "ExamplePassName" HLSLPROGRAM // Add HLSL shader program code here ENDHLSL } } ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b5287e0590d1
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystem.LightsModule`.
stem Lights Module. This module allows you to attach real-time Lights to a percentage of your particles. The Lights Module is a simple and powerful module that allows particles to cast light onto their environment easily. Lights can inherit properties from the particles they are attached to, such as color and size. Po...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f59ec50e6f12
github
scripting
Write a Unity C# script called Custom Unity String Event
```csharp using UnityEngine.Events; namespace Lynx { [System.Serializable] public class CustomUnityStringEvent : UnityEvent<string> { } [System.Serializable] public class CustomUnityIntEvent : UnityEvent<int> { } [System.Serializable] public class CustomUnityBoolEvent : Unity...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_27e8c9e5dfff_doc_3
github
scripting
What does `OnReturnToPool` do in this Unity script? Explain its purpose and signature.
Called when the object is returned to the pool.This method must be implemented by the derived class to specify custom behavior when the object is no longer in use. Signature: ```csharp public abstract void OnReturnToPool(); ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_610ae4eef4f1
unity_docs
performance
What is `Profiling.Profiler.EndSample` in Unity? Explain its purpose and usage.
Profiler.EndSample Declaration public static void EndSample (); Description Ends the current profiling sample. The Profiler displays samples in its Hierarchy and Timeline views. ```csharp using UnityEngine; using System.Collections; using UnityEngine.Profiling;public class ExampleClass : MonoBehaviour { void ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1e3e1e4d6445
unity_docs
math
What is `Vector4.magnitude` in Unity? Explain its purpose and usage.
Vector4.magnitude public float magnitude ; Description Returns the length of this vector (Read Only). The length of the vector is square root of (x*x+y*y+z*z+w*w) . If you only need to compare magnitudes of some vectors, you can compare squared magnitudes of them using sqrMagnitude (computing squared magnitu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_84c1b5a1b6b4
github
scripting
Write a Unity Editor script for bhaptics_library
```csharp using System; using System.Collections.Generic; using System.Runtime.InteropServices; using UnityEngine; namespace Bhaptics.SDK2 { public class bhaptics_library { private const string ModuleName = "bhaptics_library"; [DllImport(ModuleName, CallingConvention = CallingConvent...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_8a14f29796c2
unity_docs
rendering
What is `ParticleSystem.LightsModule.light` in Unity? Explain its purpose and usage.
ParticleSystem.LightsModule.light public Light light ; Description Select what Light Prefab you want to base your particle lights on. Additional resources: Light . ```csharp using UnityEngine; using System.Collections;// For best results, use Deferred Rendering (see Camera settings) [RequireComponent(typeo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7fee042cdbbe
unity_docs
rendering
Explain 'Introduction to cameras' in Unity.
Just as cameras are used in films to display the story to the audience, Cameras in Unity are used to display the game world to the player. A Unity scene represents GameObjects in a three-dimensional space. Since the viewer’s screen is two-dimensional, Unity needs to capture a view and “flatten” it for display. It does ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_286aeeb2418c
unity_docs
animation
Show me a Unity C# example demonstrating `AnimationState.normalizedTime`.
float normalizedTime ; Description Normalized time of the State. The normalized time is a progression ratio. The integer part is the number of times the State has looped. The fractional part is a percentage (0-1) that represents the progress of the current loop. For example, a normalized time of 0.5 means that th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fffd6fefb4e0
unity_docs
rendering
Show me a Unity C# example demonstrating `RenderTexture.ConvertToEquirect`.
ing to the left or right eye for stereoscopic rendering, or neither for monoscopic rendering. Description Converts the render texture to equirectangular format (both stereoscopic or monoscopic equirect). The left eye will occupy the top half and the right eye will occupy the bottom. The monoscopic version will occupy...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6a18d7821754
unity_docs
editor
Give me an overview of the `ColorPickerHDRConfig` class in Unity.
ColorPickerHDRConfig class in UnityEditor Description Used as input to ColorField to configure the HDR color ranges in the ColorPicker. Additional resources: EditorGUI.ColorField , EditorGUILayout.ColorField . Properties Property Description maxBrightness Maximum allowed color component value when using the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_43824fd63356
unity_docs
ui
In Unity's 'Bind to a UXML template', what is 'Create the GameSwitch asset' and how does it work?
Create scripts to define the GameSwitch struct and a custom asset to hold properties of the GameSwitch struct. Create a project in Unity with any template. In your Project window , create a folder named bind-uxml-template to store all your files. Create a C# script named GameSwitchesAsset.cs with the following contents...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2df289ce09e4
unity_docs
editor
Show me a Unity C# example demonstrating `TextureImporter.GetPlatformTextureSettings`.
etc1AlphaSplitEnabled Status of the ETC1 and alpha split flag. Returns bool True if the platform override was found, false if no override was found. Description Gets platform specific texture settings. The values for the chosen platform are returned in the out parameters. The options for the platform stri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7e306a87b570
unity_docs
scripting
What is `SystemInfo.unsupportedIdentifier` in Unity? Explain its purpose and usage.
SystemInfo.unsupportedIdentifier public static string unsupportedIdentifier ; Description Value returned by SystemInfo string properties which are not supported on the current platform. ```csharp using UnityEngine; using System.Collections;public class NewBehaviourScript : MonoBehaviour { void Start() { if (...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_be228a9ecded
unity_docs
physics
What is `Rigidbody.automaticInertiaTensor` in Unity? Explain its purpose and usage.
Rigidbody.automaticInertiaTensor public bool automaticInertiaTensor ; Description Whether or not to calculate the inertia tensor automatically. If enabled, the inertia tensor is calculated automatically based on the settings of attached Collider s. If no colliders are present, the tensor has a default value o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_66f9b4fd43c8
unity_docs
xr
What is `XR.XRDisplaySubsystem.AddGraphicsThreadMirrorViewBlit` in Unity? Explain its purpose and usage.
XRDisplaySubsystem.AddGraphicsThreadMirrorViewBlit Obsolete AddGraphicsThreadMirrorViewBlit(CommandBuffer, bool) is deprecated. Use AddGraphicsThreadMirrorViewBlit(CommandBuffer, bool, int) instead. Declaration public bool AddGraphicsThreadMirrorViewBlit ( Rendering.CommandBuffer cmd , bool allowGraphicsStateI...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e88aa342a4c2_doc_17
github
scripting
What does `EditDirectedTextMessage` do in this Unity script? Explain its purpose and signature.
Edit the text of messages they have sent.with the messageId being the ID of the message to change,and newMessage being the updated text of the message.The old messageNewMessage being the updated text of the message. Signature: ```csharp public Task EditDirectedTextMessage(TextMessage _message, string _editedMessageTex...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_2f8f88038c35
unity_docs
physics
What is `QueryTriggerInteraction` in Unity? Explain its purpose and usage.
QueryTriggerInteraction enumeration Description Overrides the global Physics.queriesHitTriggers . Overrides the global Physics.queriesHitTriggers to specify whether queries (raycasts, spherecasts, overlap tests, etc.) hit Triggers by default. Use Ignore for queries to ignore trigger Colliders. ```csharp //Crea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3c55f7f9e5ad
unity_docs
performance
What is `Rendering.BatchCullingContext.cullingPlanes` in Unity? Explain its purpose and usage.
BatchCullingContext.cullingPlanes public NativeArray<Plane> cullingPlanes ; Description Planes to cull against. This array contains the culling planes of all the BatchCullingContext.cullingSplits . Each CullingSplit contains a starting offset index and the number of the planes in the split.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6dcf3b11c421
unity_docs
rendering
In Unity's 'Set up GameObjects for batching', what is 'Check whether Unity batches GameObjects' and how does it work?
To check whether Unity batches GameObjects, open the Frame Debugger and check for either of the following: Render passes called Draw Static or Draw Dynamic . Combined Mesh in the event details of the Meshes section . If Unity isn’t batching GameObjects, check the following for each GameObject: The GameObject is active....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e70ea953fac5
unity_docs
scripting
What is `Experimental.GraphView.StackNode.OnCustomStyleResolved` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. StackNode.OnCustomStyleResolved Declaration protected void OnCustomStyleResolved ( UIElements.ICustomStyle styles ); Description Called when the custom style properties are resolved.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d1f4b5a82831
unity_docs
rendering
Give me an overview of the `TerrainLayerSmoothnessSource` class in Unity.
TerrainLayerSmoothnessSource enumeration Description Source of smoothness value used in the underlying splat material of a TerrainLayer when TerrainLayer.diffuseTexture has an alpha channel. When TerrainLayer.diffuseTexture has an alpha channel, you can set smoothness by TerrainLayer.smoothness or through ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f46e683e638a
unity_docs
scripting
What is `UIElements.GroupBox.labelUssClassName` in Unity? Explain its purpose and usage.
GroupBox.labelUssClassName public static string labelUssClassName ; Description USS class name for Labels in GroupBox elements. Unity adds this USS class to the Label sub-element of the GroupBox if the GroupBox has a Label.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09e9b0041f5a
unity_docs
editor
What is `PrefabUtility.IsOutermostPrefabInstanceRoot` in Unity? Explain its purpose and usage.
PrefabUtility.IsOutermostPrefabInstanceRoot Declaration public static bool IsOutermostPrefabInstanceRoot ( GameObject gameObject ); Parameters Parameter Description gameObject The GameObject to check. Returns bool True if the GameObject is an outermost Prefab instance root. Description Returns true ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b1a2f8f3c648
unity_docs
rendering
What is `ParticleSystem.LightsModule.intensityMultiplier` in Unity? Explain its purpose and usage.
ParticleSystem.LightsModule.intensityMultiplier public float intensityMultiplier ; Description Intensity multiplier. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall intensity multiplier. Additional resources: ParticleSystem.LightsModule.intensit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.