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_man_bdae98674bb7
unity_docs
scripting
Explain 'Manage the Inspector window' in Unity.
This page describes some options for controlling the Inspector window. For information about setting properties for GameObjects , scripts , and assets, refer to Manage components and their values . ## Open an Inspector window To open an Inspector , do one of the following: To open the Inspector as a new window, from ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d250db4f9504
unity_docs
physics
Show me a Unity C# example demonstrating `Animator.GetBehaviour`.
Animator.GetBehaviour Declaration public T GetBehaviour (); Description Returns the first StateMachineBehaviour that matches type T or is derived from T . Returns null if none are found. ```csharp using UnityEditor; using UnityEngine;public class RunBehaviour : StateMachineBehaviour { // OnStateUpdate is...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a74b4d46e60d
unity_docs
rendering
What is `Rendering.FilteringSettings.excludeMotionVectorObjects` in Unity? Explain its purpose and usage.
FilteringSettings.excludeMotionVectorObjects public bool excludeMotionVectorObjects ; Description Determines if Unity excludes GameObjects that are in motion from rendering. This refers to GameObjects that have an active Motion Vector pass assigned to their Material or have set the Motion Vector mode to per obj...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e0aaeb6571c
unity_docs
scripting
What is `SpriteRenderer.flipY` in Unity? Explain its purpose and usage.
SpriteRenderer.flipY public bool flipY ; Description Flips the sprite on the Y axis. Only the rendering is affected. Use negative Transform.scale, if you want to affect all the other components (for example colliders).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_61067b7b91f3
unity_docs
math
What is `UIElements.IPointerEvent.radiusVariance` in Unity? Explain its purpose and usage.
IPointerEvent.radiusVariance public Vector2 radiusVariance ; Description Gets the accuracy of the touch radius. Add this value to the radius to get the maximum touch radius, subtract it to get the minimum touch radius.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eaa2e2f05819
unity_docs
scripting
What is `AI.NavMesh.IsLinkActive` in Unity? Explain its purpose and usage.
NavMesh.IsLinkActive Declaration public static bool IsLinkActive ( AI.NavMeshLinkInstance handle ); Parameters Parameter Description handle The link instance whose state to query. Returns bool True if agents can plan paths through, and traverse, this instance of the link, otherwise false. Description...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_73b30f5a7bad
unity_docs
ui
Show me a Unity C# example demonstrating `EditorWindow.OnDestroy`.
EditorWindow.OnDestroy() Description OnDestroy is called to close the EditorWindow window. A simple example of OnDestroy() ```csharp // Close the window when the Button is pressed. The window // will receive an OnDestroy() call. using UnityEditor; using UnityEngine; using UnityEngine.UIElements; public class OnD...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_76fd60c42f69
unity_docs
scripting
What is `Social` in Unity? Explain its purpose and usage.
Method group is Obsolete Social class in UnityEngine / Implemented in: UnityEngine.GameCenterModule Obsolete Social is deprecated and will be removed in a future release. Description Generic access to the Social API. Social.Active can be used to target a specific social platform implementation, but by defau...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_07f1e8ec97c6
unity_docs
input
In Unity's 'Large screen and foldable device support', what is 'Resizeable Activity Player setting' and how does it work?
The Resizeable Activity Player setting enables multi-window mode in your application and allows the Android OS to consider it resizable. For new projects, Unity enables this setting by default and sets android.resizeableActivity="true" in the Android manifest file. In this case, the aspect ratio restrictions are ignore...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c2ba3eb00f31
unity_docs
scripting
What is `AndroidDeviceFilterData.vendorName` in Unity? Explain its purpose and usage.
AndroidDeviceFilterData.vendorName public string vendorName ; Description Vendor name of the GPU hardware used in the Android device. Filter based on name of the GPU vendor. For example, Qualcomm, ARM. Note : This property only accepts a valid regular expression.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_51fb6d942ce9
unity_docs
scripting
What is `AudioClip.GetData` in Unity? Explain its purpose and usage.
AudioClip.GetData Declaration public bool GetData (Span<float> data , int offsetSamples ); Declaration public bool GetData (float[] data , int offsetSamples ); Parameters Parameter Description data The array you want to fill with raw data from the audio clip. offsetSamples The index of where to sta...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8d8109d32828
unity_docs
physics
Show me a Unity C# example demonstrating `MonoBehaviour.OnMouseDown`.
tToRay with a specific camera and perform your own raycasts in scripts. This function is not called on objects that belong to Ignore Raycast layer. This function is called on Colliders and 2D Colliders marked as trigger when the following properties are set to true: For 3D physics: Physics.queriesHitTriggers For 2...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d06788f359af
unity_docs
input
What is `Playables.PlayableExtensions.SetInputCount` in Unity? Explain its purpose and usage.
PlayableExtensions.SetInputCount Declaration public static void SetInputCount (U playable , int value ); Parameters Parameter Description playable The Playable used by this operation. Description Changes the number of inputs supported by the Playable . Use this templated extension method on any type t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_545c48aca5dc
unity_docs
physics
What is `ArticulationBody.SetJointAccelerations` in Unity? Explain its purpose and usage.
Removed ArticulationBody.SetJointAccelerations Obsolete Setting joint accelerations is not supported in forward kinematics. To have inverse dynamics take acceleration into account, use GetJointForcesForAcceleration instead. Declaration public void SetJointAccelerations (List<float> accelerations ); Paramete...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4870f87988e1
unity_docs
scripting
What is `RectTransform.SetInsetAndSizeFromParentEdge` in Unity? Explain its purpose and usage.
RectTransform.SetInsetAndSizeFromParentEdge Declaration public void SetInsetAndSizeFromParentEdge ( RectTransform.Edge edge , float inset , float size ); Parameters Parameter Description edge The edge of the parent rectangle to inset from. inset The inset distance. size The size of the rectangle along...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_819f846e2ce1
unity_docs
scripting
Explain 'Changing resolution scale' in Unity.
To reduce the amount of work for the GPU and speed up rendering, you can change the resolution of the image Unity renders. Page Description Introduction to changing resolution scale Learn about the different dynamic resolution and upscaling techniques in the different render pipelines . Dynamic resolution Resources for...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_27dae66b66cb
unity_docs
rendering
Explain 'Create a drag-and-drop list and tree views between windows' in Unity.
Version : 2023.2+ Drag-and-drop is a common feature in UI design. You can use UI Toolkit to create a drag-and-drop UI inside a custom Editor window or inside an application built by Unity. This example demonstrates how to create a drag-and-drop UI with ListView and TreeView inside a custom Editor window. ## Example ov...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6269036ce068
unity_docs
scripting
Show me a Unity C# example demonstrating `StateMachineBehaviour`.
e. In that situation, the messages will be invoked once per synchronized layer that contains the state, in ascending order. Additional considerations : By default the Animator instantiates a new instance of each behaviour defined in the controller. If you wish to share behaviour instances, use the class attribute ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b29b8bacadbe
unity_docs
animation
Show me a Unity C# example demonstrating `AnimatorClipInfo.clip`.
AnimatorClipInfo.clip public AnimationClip clip ; Description Returns the animation clip played by the Animator. ```csharp //Create a GameObject and attach an Animator component (Click the Add Component button in the Inspector of the GameObject and go to Miscellaneous>Animator). Set up the Animator how you wo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_b855d84181f4_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Custom Editor for the Mask component.Extend this class to write a custom editor for a component derived from Mask. Signature: ```csharp public class MaskEditor : Editor ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_6bb3b3ba8460
unity_docs
scripting
In Unity's 'AssetBundle caching', what is 'Location of the AssetBundle cache' and how does it work?
The local AssetBundle cache exists at a root folder (for example, Application.temporaryCachePath ), with a structure like the following: ``` RootCacheFolder - BundleName1 - Hash1 __data (AssetBundle content) - Hash1__info (cache metadata) - BundleName2 - Hash2 __data - Hash2 __info ``` During download, Unity use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7ac9ef1f6989
unity_docs
editor
What is `AssetDatabase.GetCacheServerNamespacePrefix` in Unity? Explain its purpose and usage.
AssetDatabase.GetCacheServerNamespacePrefix Declaration public static string GetCacheServerNamespacePrefix (); Returns string Returns the Namespace prefix for the Cache Server. Description Gets the Cache Server Namespace prefix set in Editor Settings. Note: If you set a new value for the Namespace prefix ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_89e46145ac0d
unity_docs
rendering
Give me an overview of the `RenderingLayerMask` class in Unity.
RenderingLayerMask struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description The Render Pipeline allows you to use Rendering Layers, which are LayerMasks to make Lights or effects only affect specific Renderers. Rendering Layers are also supported on decal projectors, and can be sampled from th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eb71f2739659
unity_docs
rendering
What is `TextureFormat.ETC2_RGBA8Crunched` in Unity? Explain its purpose and usage.
TextureFormat.ETC2_RGBA8Crunched Description Compressed color with alpha channel texture format using Crunch compression for smaller storage sizes. The ETC2_RGBA8Crunched format is similar to the ETC2_RGBA8 format but with additional JPEG-like lossy compression for storage size reduction. Textures are transcoded ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0d181cd8ae8d
unity_docs
editor
What are the parameters of `EditorGUI.PasswordField` in Unity?
Returns string The password entered by the user. Description Makes a text field where the user can enter a password. This works just like GUI.PasswordField , but correctly responds to select all, etc. in the editor, and it can have an optional label in front. Password Field in an Editor Window. ```csharp using UnityEng...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9055363c7f75_doc_1
github
scripting
What does `StartStaticCoroutine` do in this Unity script? Explain its purpose and signature.
Starts a coroutine on the instance.The coroutine to start.The coroutine that was started. Signature: ```csharp public static UnityEngine.Coroutine StartStaticCoroutine(IEnumerator coroutine) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_f82b7dab51bd
unity_docs
rendering
What is `SystemInfo.maxComputeWorkGroupSizeX` in Unity? Explain its purpose and usage.
SystemInfo.maxComputeWorkGroupSizeX public static int maxComputeWorkGroupSizeX ; Description The maximum number of work groups that a compute shader can use in X dimension (Read Only). This is the largest number of work groups (in X dimension) that a compute shader on the current device can use.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_58db51ed8435
unity_docs
editor
Explain 'Adaptive Performance' in Unity.
com.unity.adaptiveperformance ## Description The Adaptive Performance package provides an API to get feedback about the thermal and power state of mobile devices, enabling applications to make performance-relevant adaptions at runtime. For instruction on how to use samples, please read the documentation. By installin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9bd18b01a8b1
unity_docs
editor
Show me a Unity C# example demonstrating `VersionControl.Provider.DiffHead`.
ription assets List of assets to diff. includingMetaFiles Whether or not to include the .meta file. Description Starts a task for showing a diff of the given assest versus their head revision. Do note that some asset types do not save their changes to disk right after making them so it is recommended to manually...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e0c1920d177e
unity_docs
scripting
What is `StateMachineBehaviour` in Unity? Explain its purpose and usage.
StateMachineBehaviour class in UnityEngine / Inherits from: ScriptableObject / Implemented in: UnityEngine.AnimationModule Description StateMachineBehaviour is a component that can be added to a state machine state. It's the base class any script on a state must derive from. State machines can have up to thre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_22ed980e0450
unity_docs
scripting
What is `Profiling.HierarchyFrameDataView.GetItemMergedSamplesCount` in Unity? Explain its purpose and usage.
HierarchyFrameDataView.GetItemMergedSamplesCount Declaration public int GetItemMergedSamplesCount (int id ); Parameters Parameter Description id Hierarchy item identifier. Returns int Returns merged samples count represented by the tree item. Description Return merged samples count represented by the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e72a5bdd60d3
unity_docs
scripting
Show me a Unity C# example demonstrating `Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetricsFilters`.
cting specific categories of data when summarizing AsyncReadManager metrics. Pass a filter to AsyncReadManagerMetrics.GetCurrentSummaryMetrics or AsyncReadManagerMetrics.GetSummaryOfMetrics to limit the summary to the categories of data specified in the filter. For each category supported by the AsyncReadManage...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2c839ff4892b
unity_docs
physics
What is `IMGUI.Controls.JointAngularLimitHandle.zMotion` in Unity? Explain its purpose and usage.
JointAngularLimitHandle.zMotion public ConfigurableJointMotion zMotion ; Description Returns or specifies how angular motion is limited about the z-axis. Defaults to ConfigurableJointMotion.Limited . Additional resources: zMin , zMax , zRange .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_efca6e1d8e4c
unity_docs
rendering
In Unity's 'Default project directories', what is 'Library' and how does it work?
The Library folder contains a local cache of imported assets and metadata. Exclude the Library folder from version control, because it’s unique to your computer and is a working directory for your project. It also doesn’t display in the Project window of the Unity Editor. You can delete the Library folder to troublesho...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fbdfe8504773
unity_docs
input
In Unity's 'The SearchProvider class', what is 'Initialization' and how does it work?
Because the Search item list uses a virtual scrolling algorithm, some SearchItem fields (for example, label , thumbnail , and description ) are fetched on demand, if they are not already provided. To populate those fields after the items are created, you need to initialize the SearchProvider with specific handlers ( fe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4537818d0785_doc_9
github
scripting
What does `OnEnable` do in this Unity script? Explain its purpose and signature.
Performs general setup for the interactable, load the initial scales and connects the scale reset event. Signature: ```csharp protected override void OnEnable() ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_1f10df0a6252
unity_docs
rendering
Give me an overview of the `ParticleSystemRingBufferMode` class in Unity.
ParticleSystemRingBufferMode enumeration Description Control how particles are removed from the Particle System. Properties Property Description Disabled Particles are removed when their age exceeds their lifetime. PauseUntilReplaced Particle ages pause at the end of their lifetime until they need to be remove...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ac53d2439bd
unity_docs
scripting
What is `HeaderAttribute.ctor` in Unity? Explain its purpose and usage.
HeaderAttribute Constructor Declaration public HeaderAttribute (string header ); Parameters Parameter Description header The header text. Description Add a header above some fields in the Inspector. This header is only displayed when the field is visible in the Inspector. If the field is private or decora...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5b196c6a401e
unity_docs
math
Give me an overview of the `Vector4` class in Unity.
Vector4 struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Representation of four-dimensional vectors. This structure is used in some places to represent four component vectors (e.g. mesh tangents, parameters for shaders). In the majority of other cases a Vector3 is used. Static Prope...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9289c473589d
unity_docs
ui
In Unity's 'Import and preview video clips', what is 'Import your file as a video clip' and how does it work?
To import your file as a video clip, do one of the following: Click and drag a video file into the Assets folder. Go to Assets > Import New Asset and select a video file. Next, configure your Video Clip Importer properties or reference the video clip in the Video Player.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a04492a58ebc
unity_docs
audio
What is `iOS.Xcode.ProjectCapabilityManager` in Unity? Explain its purpose and usage.
ProjectCapabilityManager class in UnityEditor.iOS.Xcode Description Use this class to add and modify the details of the Xcode project capabilities. Note : The recommended best practice is to place the ProjectCapabilityManager methods inside a Try-Catch block as they might throw exceptions when called multiple tim...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_42202ced9d22
unity_docs
scripting
What is `ColorGamutUtility.GetTransferFunction` in Unity? Explain its purpose and usage.
ColorGamutUtility.GetTransferFunction Declaration public static TransferFunction GetTransferFunction ( ColorGamut gamut ); Parameters Parameter Description gamut The color gamut to look up. Returns TransferFunction The transfer function that the given gamut uses. Description Returns the transfer f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_549ce302959d
unity_docs
scripting
What is `GUIUtility.ScreenToGUIPoint` in Unity? Explain its purpose and usage.
GUIUtility.ScreenToGUIPoint Declaration public static Vector2 ScreenToGUIPoint ( Vector2 screenPoint ); Description Convert a point from screen space to GUI position. Used for reconverting values calculated from GUIToScreenPoint Note: In Unity the screen space y coordinate varies from zero at the top ed...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_275d16c5d065
unity_docs
scripting
What is `IMGUI.Controls.MultiColumnHeaderState.OverwriteSerializedFields` in Unity? Explain its purpose and usage.
MultiColumnHeaderState.OverwriteSerializedFields Declaration public static void OverwriteSerializedFields ( IMGUI.Controls.MultiColumnHeaderState source , IMGUI.Controls.MultiColumnHeaderState destination ); Parameters Parameter Description source State that have serialized data to be transfered to the d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d1eb82cc0ac
unity_docs
scripting
What is `Experimental.GraphView.StackNode.DragUpdated` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. StackNode.DragUpdated Declaration public bool DragUpdated ( UIElements.DragUpdatedEvent evt , IEnumerable<ISelectable> selection , Experimental.GraphView.IDropTarget dropTarget , Experimental.GraphView.ISelection dragSou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d0c6b64a640
unity_docs
rendering
Give me an overview of the `ParticleSystemInheritVelocityMode` class in Unity.
ParticleSystemInheritVelocityMode enumeration Description How to apply emitter velocity to particles. Properties Property Description Initial Each particle inherits the emitter's velocity on the frame when it was initially emitted. Current Each particle's velocity is set to the emitter's current velocity value...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a68fa0a35ebc
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUILayout.IntPopup`.
idth , GUILayout.MaxWidth , GUILayout.MinHeight , GUILayout.MaxHeight , GUILayout.ExpandWidth , GUILayout.ExpandHeight . Returns int The value of the option that has been selected by the user. Description Make an integer popup selection field. Takes the currently selected integer as a parameter and return...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c36e0152680
unity_docs
scripting
What is `Caching.MoveCacheAfter` in Unity? Explain its purpose and usage.
Caching.MoveCacheAfter Declaration public static void MoveCacheAfter ( Cache src , Cache dst ); Parameters Parameter Description src The Cache to move. dst The Cache which should come before the source Cache in the cache list. Description Moves the source Cache after the destination Cache in the cach...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eb15d77e8434
unity_docs
rendering
Show me a Unity C# example demonstrating `Search.SearchItemProviderAttribute`.
SearchItemProviderAttribute class in UnityEditor.Search Description Attribute used to declare a static method that will create a new search provider at load time. ``` [SearchItemProvider] internal static SearchProvider CreateProvider() { return new SearchProvider(id, name) { filterId = "hex:", priority = 9999...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cfe7f707e8b1
unity_docs
editor
What is `iOS.Device.deferSystemGesturesMode` in Unity? Explain its purpose and usage.
Device.deferSystemGesturesMode public static iOS.SystemGestureDeferMode deferSystemGesturesMode ; Description Defer system gestures until the second swipe on specific edges. Select one or more edges that users must swipe twice to enact system gestures. On iOS devices, users can perform actions by swiping from...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57e7e093909b
unity_docs
physics
Show me a Unity C# example demonstrating `Unity.Profiling.Memory.MemoryProfiler.TakeTempSnapshot`.
nt that is fired once the memory snapshot has finished the process of capturing data. captureFlags Flag mask defining the content of the memory snapshot. Description Triggers a memory snapshot capture to the Application.temporaryCachePath folder. Internally MemoryProfiler.TakeSnapshot is called with the destin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cfe734932299
unity_docs
rendering
What is `Rendering.LightEvent.AfterShadowMap` in Unity? Explain its purpose and usage.
LightEvent.AfterShadowMap Description After shadowmap is rendered. This value indicates all shadow casters are rendered and the current render target is still the shadow map. Note that shadow cascade parameters are not yet set. See LightEvent.BeforeScreenspaceMask for more information.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_86ca96eac243
unity_docs
performance
Explain 'Entities' in Unity.
com.unity.entities ## Description The Entities package provides a modern Entity Component System (ECS) implementation with a basic set of systems and components made for Unity. ## Released for Unity Package version 1.4.5 is released for Unity Editor version 6000.0.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_91ffa9265ebf
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.RGBA_ETC2_UNorm` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.RGBA_ETC2_UNorm Description A four-component, ETC2 compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha va...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a3b519f99b76
unity_docs
scripting
What is `AI.NavMeshBuildMarkup.overrideArea` in Unity? Explain its purpose and usage.
NavMeshBuildMarkup.overrideArea public bool overrideArea ; Description Use this to specify whether the area type of the GameObject and its children should be overridden by the area type specified in this struct.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_500aa974fe33
github
scripting
Write a Unity C# UI script for Grid Minimap View
```csharp using FactoryMustScale.Authoring; using FactoryMustScale.Simulation; using UnityEngine; namespace FactoryMustScale.Runtime.Visualization { /// <summary> /// Grid minimap presenter setup: /// 1) Add SimulationLoopDriver to a scene object and configure the real simulation state. /// 2) Add SimL...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_f1f471ba8581
unity_docs
scripting
What is `ScreenOrientation.AutoRotation` in Unity? Explain its purpose and usage.
ScreenOrientation.AutoRotation Description Autorotates the screen as necessary toward any of the enabled orientations. When you assign ScreenOrientation.AutoRotation to the Screen.orientation property, the screen autorotates so that the bottom of the image points downwards. To set permitted orientations, use the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c9b19a102df
unity_docs
rendering
What is `Rendering.DrawingSettings.enableInstancing` in Unity? Explain its purpose and usage.
DrawingSettings.enableInstancing public bool enableInstancing ; Description Controls whether instancing is enabled. Instancing is enabled by default. Additional resources: ScriptableRenderContext.DrawRenderers.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cff612df55d9
unity_docs
scripting
What is `Search.SearchIndexer.Dispose` in Unity? Explain its purpose and usage.
SearchIndexer.Dispose Declaration public void Dispose (); Description Dispose of the SearchIndexer . It is important to dispose of the SearchIndexer to release its resources when it is no longer needed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5c36e614d2ba
unity_docs
scripting
Explain 'Quit a Unity Android application' in Unity.
The Android operating system has a built-in user interface to hide and close applications (refer to Close apps ) so you shouldn’t add your own interface to quit your application. Users recognize Android’s interface as the way to close applications so if you create your own, users will have an inconsistent user experien...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_92fd926098f1
unity_docs
scripting
Explain 'Get started with Embedded Linux' in Unity.
Learn how to set up a project for Embedded Linux development. Topic Description Install the platform package for Embedded Linux Install the platform package for Embedded Linux on your selected platform. Set up your environment for Embedded Linux Set up your environment to develop for Embedded Linux. Embedded Linux Play...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_159ea8496fda
unity_docs
scripting
Show me a Unity C# example demonstrating `GameObject.layer`.
ers for its own systems. Refer to Create functional layers in Unity for a list of predefined layers and how to create your own new ones. To convert this layer identifier to a LayerMask , refer to Set a layerMask . To obtain the string name of the layer from this layer identifier, use LayerMask.LayerToName ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4096336c1f89
unity_docs
scripting
In Unity's 'Upgrade an asset package for the Asset Store', what is 'Upgrade types' and how does it work?
You can apply the following upgrade types: Major Upgrade : A new version of an existing package that contains significant differences to the previous package version. The original package must have been available on the Asset Store for more than a year. A major upgrade includes reviews that users left for the last majo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a242508cf332
unity_docs
networking
What is `Android.AndroidScreenLayoutDirection.RTL` in Unity? Explain its purpose and usage.
AndroidScreenLayoutDirection.RTL Description Mirrors the Android property value SCREENLAYOUT_LAYOUTDIR_RTL . For information about the property value, refer to the Android developer documentation on SCREENLAYOUT_LAYOUTDIR_RTL .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_803f66887d75
unity_docs
scripting
Show me a Unity C# example demonstrating `KeyCode.F`.
KeyCode.F Description 'f' key. ```csharp //Attach this to a GameObject //This script tells when the F arrow key is pressed down and when it is released using UnityEngine;public class Example : MonoBehaviour { void Update() { //Detect when the F arrow key is pressed down if (Input.GetKeyDown(KeyCode.F)) { Debu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_806e262f3a57
unity_docs
performance
What is `Progress.SetStepLabel` in Unity? Explain its purpose and usage.
Progress.SetStepLabel Declaration public static void SetStepLabel (int id , string label ); Parameters Parameter Description id The progress indicator's unique ID. label The steps label. Description Sets the label that displays a progress indicator's steps. This label displays a progress indicator's re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_db9e7d867e39_doc_2
github
scripting
What does `IsTracked` do in this Unity script? Explain its purpose and signature.
Define if the current controller with given handedness is tracked.Define spcific chirality to track.True if the controller with given handedness is tracked Signature: ```csharp public abstract bool IsTracked(EHandedness handedness); ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_bcafaa63d985
unity_docs
rendering
Explain 'Fix light bleeding in lightmaps' in Unity.
Each lightmap texture contains a number of UV charts . At runtime, Unity maps these UV charts onto mesh faces, and uses the charts’ lighting data to calculate the final appearance. Because of the way GPU sampling works, data from one UV chart can bleed onto another if they are too close to each other. This usually lead...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0306ac617b6e
unity_docs
scripting
What are the parameters of `Handles.DrawWireDisc` in Unity?
Description Draws the outline of a flat disc in 3D space. The Handles.color and Handles.matrix properties colorize and additionally transform the disc position. Unity ignores DrawWireDisc (that is, nothing happens) when the current GUI event type is not Repaint . Wire Disc in the Scene View. ```csharp using UnityEngine...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ac54f46786a5
unity_docs
scripting
In Unity's 'ToolbarBreadcrumbs', what is 'Inherited UXML attributes' and how does it work?
This element inherits the following attributes from its base class: Name Type Description focusable boolean If false, this prevents the element from being focused. The element can only be focused if its canGrabFocus property is true. tabindex int An integer used to sort focusable elements in the focus ring. Must be gre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_34eba10af8e4
unity_docs
rendering
What is `Rendering.GraphicsSettings.TrySetCurrentRenderPipelineGlobalSettings` in Unity? Explain its purpose and usage.
GraphicsSettings.TrySetCurrentRenderPipelineGlobalSettings Declaration public static bool TrySetCurrentRenderPipelineGlobalSettings ( Rendering.RenderPipelineGlobalSettings asset ); Parameters Parameter Description asset The RenderPipelineGlobalSettings asset to activate for the project. Returns bool ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_852f3d9a01e6
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.cacheServerConnectionChanged`.
AssetDatabase.cacheServerConnectionChanged Parameters Parameter Description value Use CacheServerConnectionChangedParameters for this event. Description Unity raises this event when Cache Server connection is changed. ```csharp using UnityEngine; using UnityEditor;public class CacheServerConnectionChangedExa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1e993f290794
unity_docs
scripting
What is `GraphicsBuffer.Target.CopyDestination` in Unity? Explain its purpose and usage.
GraphicsBuffer.Target.CopyDestination Description GraphicsBuffer can be used as a destination for CopyBuffer. The destination buffer for Graphics.CopyBuffer or CommandBuffer.CopyBuffer must have CopyDestination target set. This target is most often combined with other target flags. ```csharp using UnityEngin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9a26ae7ce7d
unity_docs
scripting
What is `UIElements.StyleTransformOrigin` in Unity? Explain its purpose and usage.
StyleTransformOrigin struct in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Implements interfaces: IStyleValue<T0> Description Represents a style value that can be either a TransformOrigin or a StyleKeyword . Properties Property Description keyword The style keyword. valu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_339fd1d0f679
unity_docs
rendering
Show me a Unity C# example demonstrating `CubemapArray.GetPixelData`.
oint to the correct memory location if the texture has been modified or updated. If you use a small type for T such as byte , GetPixelData may fail because the NativeArray would exceed the maximum length ( Int32.MaxValue ). To avoid this, use a larger type or struct. GetPixelData throws an exception when it fai...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_70c782acb5c2
unity_docs
performance
Explain 'IUnityMemoryManager API reference' in Unity.
This pages provides the API reference for the IUnityMemoryManager interface. ## Declaration void* (UNITY_INTERFACE_API * Reallocate)(UnityAllocator * allocator, void* ptr, size_t size, size_t align, const char* file, int32_t line); ## Parameters Parameter Description UnityAllocator * allocator The allocator to use ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_179b8a6e586a
unity_docs
animation
What is `Animations.TransformStreamHandle.GetPosition` in Unity? Explain its purpose and usage.
TransformStreamHandle.GetPosition Declaration public Vector3 GetPosition ( Animations.AnimationStream stream ); Parameters Parameter Description stream The AnimationStream that holds the animated values. Returns Vector3 The position of the transform in world space. Description Gets the position ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2cec765c94a0
unity_docs
scripting
What is `Experimental.GraphView.Edge.CreateEdgeControl` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Edge.CreateEdgeControl Declaration protected Experimental.GraphView.EdgeControl CreateEdgeControl (); Returns EdgeControl The created EdgeControl. Description Create the EdgeControl.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_42204d09a35f
unity_docs
physics
What is `Rigidbody.AddRelativeTorque` in Unity? Explain its purpose and usage.
Rigidbody.AddRelativeTorque Declaration public void AddRelativeTorque ( Vector3 torque , ForceMode mode = ForceMode.Force); Parameters Parameter Description torque Torque vector in local coordinates. Description Adds a torque to the rigidbody relative to its coordinate system. Force can be applied o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d81660101c22
unity_docs
scripting
What is `Rendering.CommandBuffer.NextSubPass` in Unity? Explain its purpose and usage.
CommandBuffer.NextSubPass Declaration public void NextSubPass (); Description Start the next native subpass as discribed by CommandBuffer.BeginRenderPass . This can only be called during an active native render pass (encapsulated by CommandBuffer.BeginRenderPass and CommandBuffer.EndRenderPass ). You need t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3208b8f937f9
unity_docs
scripting
What is `Compilation.ReferencesOptions` in Unity? Explain its purpose and usage.
ReferencesOptions enumeration Description Options to control the Unity References to other assembly definition files that Unity uses during compilation. Additional resources: AssemblyBuilder.referencesOptions. Properties Property Description None Default options. UseEngineModules Use UnityEngine modules when ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab3ba374cd7d
unity_docs
scripting
What is `AI.NavMeshAgent.SetAreaCost` in Unity? Explain its purpose and usage.
NavMeshAgent.SetAreaCost Declaration public void SetAreaCost (int areaIndex , float areaCost ); Parameters Parameter Description areaIndex Area cost. areaCost New cost for the specified area index. Description Sets the cost for traversing over areas of the area type. If you enable or disable the agent ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_117922fd34cd
unity_docs
scripting
What is `ObjectChangeKind.ChangeGameObjectStructure` in Unity? Explain its purpose and usage.
ObjectChangeKind.ChangeGameObjectStructure Description A change of this type indicates that the structure of a GameObject has changed. This happens when a component is added to or removed from the GameObject using Undo.AddComponent or Undo.DestroyObjectImmediate .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_138fdb84a130_doc_4
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Event emitted when the locale changes.The parameters are: locale_name Signature: ```csharp public UnityEvent<string> OnLocaleNameChanged; ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_d03d561d0b18
unity_docs
scripting
What is `GameObject.sceneCullingMask` in Unity? Explain its purpose and usage.
GameObject.sceneCullingMask public ulong sceneCullingMask ; Description The Scene culling mask defined for the GameObject. (Read Only) Unity uses SceneCullingMasks to determine which scene to render the GameObject in. The sceneCullingMask is a bitfield stored as an unsigned 64-bit integer ulong . Cameras...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_93e8bd1aed2a
unity_docs
editor
What are the parameters of `SettingsProvider.GetSearchKeywordsFromSerializedObject` in Unity?
Returns IEnumerable<string> Returns the list of keywords. Description Extract search keywords from the serialized properties of a SerializedObject . ```csharp using UnityEngine; using UnityEditor;// Create a new type of Settings Asset. class MyCustomSettings : ScriptableObject { public const string k_MyCustomSettin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5413dc89b165
unity_docs
editor
What are the parameters of `VersionControl.Provider.CheckoutIsValid` in Unity?
Description Given an asset or a list of assets this function returns true if Provider.Checkout is a valid task to perform on at least one of the given assets. The CheckoutMode option can be used to narrow down the asset list to a specific type. For example: to only check whether meta files can be checked out and to ig...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_302eeb0f32f4
unity_docs
input
What is `TouchScreenKeyboardType.Default` in Unity? Explain its purpose and usage.
TouchScreenKeyboardType.Default Description The default keyboard layout of the target platform. An iOS example is shown below: ```csharp using UnityEngine; using UnityEngine.iOS;public class ExampleClass : MonoBehaviour { private TouchScreenKeyboard keyboard; protected void OnGUI() { GUI.skin.button.fontSize = ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d6d8f2f8f609
unity_docs
rendering
Give me an overview of the `LightmapData` class in Unity.
LightmapData class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Data of a lightmap. A Scene can have several lightmaps stored in it, and Renderer components can use those lightmaps. This makes it possible to use the same material on multiple objects, while each object can refer to a dif...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fa82d521195a
unity_docs
rendering
Show me a Unity C# example demonstrating `MonoBehaviour.OnValidate`.
ate the data that changed. Don't use it to do other tasks such as creating objects or calling other non-thread-safe Unity API. You can't reliably perform Camera rendering operations from OnValidate . Instead, add a listener to EditorApplication.update , and perform the rendering during the next Editor Update call. Ad...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3b35aaa1d2b9
unity_docs
scripting
What is `CollisionFlags` in Unity? Explain its purpose and usage.
CollisionFlags enumeration Description CollisionFlags is a bitmask returned by CharacterController.Move. It gives you a broad overview of where your character collided with any other objects. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Update() { Chara...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_04de470e970c
unity_docs
rendering
In Unity's 'Highlights Profiler module reference', what is 'Target Frame Time' and how does it work?
Use the dropdown to set a target frames per second (FPS) for your application. Select from a preset value, or select Custom to set your own. When you select Custom , the Profiler Preferences window opens.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3db719253716
unity_docs
editor
In Unity's 'Install Unity on offline computers', what is 'Unity installation on offline computers' and how does it work?
Follow these steps to run the script that the Download Assistant generates to install Unity Editor and components on offline computers. Transfer the folder that includes all the downloaded installation files and the install.sh or install.bat file from the first computer to the offline computer. On the offline computer,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78311af61f94
unity_docs
math
What is `RectTransform.GetLocalCorners` in Unity? Explain its purpose and usage.
RectTransform.GetLocalCorners Declaration public void GetLocalCorners (Vector3[] fourCornersArray ); Parameters Parameter Description fourCornersArray The array that corners are filled into. Description Get the corners of the calculated rectangle in the local space of its Transform. Each corner provides ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cfa456a9ca08
unity_docs
rendering
What is `Camera.gateFit` in Unity? Explain its purpose and usage.
Camera.gateFit public Camera.GateFitMode gateFit ; Description There are two gates for a camera, the sensor gate and the resolution gate. The physical camera sensor gate is defined by the sensorSize property, the resolution gate is defined by the render target area. To use this property, enable usePhysica...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a31a2f4987b
unity_docs
scripting
What is `LightmapParameters` in Unity? Explain its purpose and usage.
LightmapParameters class in UnityEditor / Inherits from: Object Description Configures how Unity bakes lighting and can be assigned to a LightingSettings instance or asset. Note that Unity's built-in Lightmap Parameters Assets are read-only. Additional resources: LightmapParameters.SetLightmapParametersFor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8a99e2bb2e67
unity_docs
rendering
In Unity's 'Set up a scene for occlusion culling', what is 'Baking the data' and how does it work?
In the top menu, select Window > Rendering > Occlusion Culling to open the Occlusion Culling window . Select the Bake tab. In the bottom right hand corner of the Inspector window, press the Bake button. Unity generates the occlusion culling data, saves the data as an asset in your Project, and links the asset with the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_26968f2b2159
unity_docs
scripting
What is `Windows.Directory.CreateDirectory` in Unity? Explain its purpose and usage.
Directory.CreateDirectory Declaration public static void CreateDirectory (string path ); Parameters Parameter Description path The directory path to create. Description Creates directory in the specified path. Note: This method is only available on the Universal Windows Platform.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f4f9c6cc432a
unity_docs
scripting
Explain 'ProgressBar' in Unity.
A ProgressBar element displays the progress of an ongoing task or process. Use it to provide visual feedback to the user about the progress of a task, such as file downloads, game level loading, or any other task that might take a while to complete. You can set low and high values for the ProgressBar. The ProgressBar’s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d3bb670a9da6
unity_docs
scripting
What are the parameters of `Handles.ScaleHandle` in Unity?
Returns Vector3 The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function. Description Make a Scene view scale handle. This will behave like the built-in scale tool Note: Use HandleUtility.GetHandleSize where you...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.