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_954526ff45a0
unity_docs
scripting
Explain 'Structure UI with UXML' in Unity.
Unity Extensible Markup Language (UXML) files are text files that define the structure of the UI. UXML along with USS makes it easier for less technical users to define the layout and the style of the UI. This leaves developers with technical tasks, such as importing assets, defining logic, and processing data. Topic D...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_30304a9c26b8
unity_docs
scripting
Show me a Unity code example for 'Add a layer to a layerMask'.
To add a layer to a layermask, use the logical OR operator on the original layermask and the layer to add. ``` originalLayerMask |= (1 << layerToAdd); ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e2413cb5aa86
unity_docs
scripting
What is `Experimental.GraphView.SearchTreeGroupEntry.ctor` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. SearchTreeGroupEntry Constructor Declaration public SearchTreeGroupEntry ( GUIContent content , int level ); Parameters Parameter Description content The text and icon of the group entry. level The level of the group ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8cc7bc18a258
unity_docs
scripting
What is `Rendering.StencilState.SetZFailOperation` in Unity? Explain its purpose and usage.
StencilState.SetZFailOperation Declaration public void SetZFailOperation ( Rendering.StencilOp value ); Parameters Parameter Description value The value to set. Description What to do with the contents of the buffer if the stencil test passes, but the depth test fails. Sets zFailOperationBack and zFai...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3be2260a0b17
unity_docs
scripting
What is `Projector.orthographic` in Unity? Explain its purpose and usage.
Projector.orthographic public bool orthographic ; Description Is the projection orthographic ( true ) or perspective ( false )? When orthographic is true , projection is defined by orthographicSize . When orthographic is false , projection is defined by fieldOfView . Additional resources: projector compo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_baa71273505a
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystem.RotationOverLifetimeModule.x`.
ParticleSystem.RotationOverLifetimeModule.x public ParticleSystem.MinMaxCurve x ; Description Rotation over lifetime curve for the x-axis. Additional resources: MinMaxCurve . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass : MonoBeh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_51fa7498577f
unity_docs
physics
What is `Joint2D.GetReactionTorque` in Unity? Explain its purpose and usage.
Joint2D.GetReactionTorque Declaration public float GetReactionTorque (float timeStep ); Parameters Parameter Description timeStep The time to calculate the reaction torque for. Returns float The reaction torque of the joint in the specified timeStep . Description Gets the reaction torque of the join...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bd261f9b65f4
unity_docs
scripting
What is `SystemInfo.supports32bitsIndexBuffer` in Unity? Explain its purpose and usage.
SystemInfo.supports32bitsIndexBuffer public static bool supports32bitsIndexBuffer ; Description Are 32-bit index buffers supported? (Read Only) Additional resources: Mesh.indexFormat , IndexFormat .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55f2cf5941c5
unity_docs
rendering
What is `ParticleSystem.Clear` in Unity? Explain its purpose and usage.
ParticleSystem.Clear Declaration public void Clear (); Declaration public void Clear (bool withChildren = true); Parameters Parameter Description withChildren Clear all child Particle Systems as well. Description Remove all particles in the Particle System. This method also removes the particles fro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_189b4ae0a8f6
unity_docs
rendering
What is `Rendering.RealtimeGICPUUsage.High` in Unity? Explain its purpose and usage.
RealtimeGICPUUsage.High Description 75% of the allowed CPU threads are used as worker threads. 75% of the total number of allowed logical CPU cores are populated with Enlighten Realtime Global Illumination worker threads. Additional resources: TierSettings.realtimeGICPUUsage .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ad0969650d6
unity_docs
performance
What is `Profiling.Profiler.IsCategoryEnabled` in Unity? Explain its purpose and usage.
Profiler.IsCategoryEnabled Declaration public static bool IsCategoryEnabled ( Unity.Profiling.ProfilerCategory category ); Parameters Parameter Description category Which category you want to check the state of. Returns bool Returns whether or not a given ProfilerCategory is currently enabled. Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b4f4d96b91da
unity_docs
editor
In Unity's 'Create your own overlay', what is 'Create a panel overlay' and how does it work?
All overlays must inherit from the Overlay base class and implement the CreatePanelContent method. This creates a basic panel that you can use and that you can add toolbar elements to. To create a panel overlay: Create a new C# script in the Editor folder and name it. Open the script you created. Remove the default con...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_42e04e2ac848
unity_docs
ui
Show me a Unity C# example demonstrating `GUIStyle.clipping`.
GUIStyle.clipping public TextClipping clipping ; Description What to do when the contents to be rendered is too large to fit within the area given. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Prints how is managed the text when the contents rendered // are too large to fir in the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2f02f1442de
unity_docs
physics
What is `Search.SearchViewFlags.OpenInTextMode` in Unity? Explain its purpose and usage.
SearchViewFlags.OpenInTextMode Description This flag forces the picker to open in text mode. When this flag is set, the picker will open in text mode. When it is not set, the picker will open in the last mode used. ```csharp [SearchContext("t:material", "asset", SearchViewFlags.OpenInTextMode)] public Material sel...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c61ae0c17ce4_doc_0
github
scripting
What does `GoToMenu` do in this Unity script? Explain its purpose and signature.
Disables the gameObject this component is attached to and activates the provided menu.Menu to switch to. Signature: ```csharp public void GoToMenu(BasicMenuLogic menu) ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_c6a0123c1311
unity_docs
scripting
Show me a Unity code example for 'Create custom Editors with IMGUI'.
ore modern, flexible, and scalable solution than IMGUI. To speed up application development, create custom editors for components you commonly use. This page shows you how to create a simple script to make GameObjects always look at a point. Create a C# script and name it “LookAtPoint”. Open the script and replace its ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_34c9cb36d947
unity_docs
ui
In Unity's 'UI Document component', what is 'Connect the UI to a panel' and how does it work?
To Connect the UI to a panel, in the Inspector window of the UI Document component, configure UI Document component. Panel Settings : The Panel Settings asset that renders the UI. Source Asset : The UXML document that contains the UI to display. Sort Order : The rendering order of the UI Document component. The lower t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9ac496328fc
unity_docs
scripting
What is `Experimental.GraphView.EdgeConnector_1.edgeDragHelper` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeConnector<T0>.edgeDragHelper public Experimental.GraphView.EdgeDragHelper edgeDragHelper ; Description Reference to the edge drag helper.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_14adc842f2dc
unity_docs
editor
Explain 'Integrate Unity into UWP applications' in Unity.
You can use the Unity as a Library feature to integrate the Unity Runtime Library in Universal Windows Platform (UWP) applications. The Unity Runtime Library exposes API controls to manage when and how to load, activate, and unload content within another UWP application. This integration enables you to include Unity-po...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c31009c51d3c
unity_docs
physics
What is `Rigidbody2D.Sleep` in Unity? Explain its purpose and usage.
Rigidbody2D.Sleep Declaration public void Sleep (); Description Make the rigidbody "sleep". Sleeping is an optimisation that is used to temporarily remove an object from physics simulation when it is at rest. This function makes the rigidbody sleep - it is sometimes desirable to enable this manually rather tha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_342ab59e6a4c
unity_docs
audio
Show me a Unity C# example demonstrating `Audio.AudioMixer.FindMatchingGroups`.
the format Master Group/Child of Master Group/Grandchild of Master Group , and so on. For example, in the hierarchy below, the group DROPS has the path Master/WATER/DROPS . To return only the group called DROPS , enter DROPS . The substring Master/AMBIENCE returns three groups, AMBIENCE/CROWD , AMBIENCE/ROAD , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a107fdeec9ff
unity_docs
animation
What is `AnimatorTransitionInfo` in Unity? Explain its purpose and usage.
AnimatorTransitionInfo struct in UnityEngine / Implemented in: UnityEngine.AnimationModule Description Information about the current transition. Properties Property Description anyState Returns true if the transition is from an AnyState node, or from Animator.CrossFade. duration Duration of the transition. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_069c3a932655
unity_docs
editor
In Unity's 'Assign icons to inspected items', what is 'Icon types' and how does it work?
The Unity Editor supports three icons types. Icon type Description Label icons Colored capsules that show the item’s name. Image only icons Colored circles. They’re useful for objects that don’t have a visual representation such as waypoints. Custom icons (other) An icon based on an asset in the project. For example, u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_feec800aee88
unity_docs
rendering
Show me a Unity C# example demonstrating `AssetDatabase.Contains`.
ool Contains (int instanceID ); Parameters Parameter Description obj The asset object to check. entityId The EntityID of an asset to check. instanceID The InstanceID of an asset to check. Returns bool Returns true if the object, EntityID, or InstanceID corresponds to a file in the Assets folder. Otherw...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4a1a90faa3c2
unity_docs
physics
What is `Joint2D.OnJointBreak2D` in Unity? Explain its purpose and usage.
Joint2D.OnJointBreak2D(Joint2D) Description Called when a Joint2D attached to the same game object breaks. When the Joint2D.reactionForce is higher than the Joint2D.breakForce or the Joint2D.reactionTorque is higher than the Joint2D.breakTorque of the joint, the joint will break. When the joint breaks, J...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a52ff3a25f8f_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
class BaseDynamicViewThe class is a subtype of BaseView which should be used in cases when some viewwill be created in runtime using GameObject.Instantiate or some factory Signature: ```csharp public abstract class BaseDynamicView : BaseView ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_0cfe33e466cf
unity_docs
rendering
What is `ShaderKeywordFilter.ApplyRulesIfNotGraphicsAPIAttribute.ctor` in Unity? Explain its purpose and usage.
ApplyRulesIfNotGraphicsAPIAttribute Constructor Declaration public ApplyRulesIfNotGraphicsAPIAttribute (params GraphicsDeviceType[] graphicsDeviceTypes ); Parameters Parameter Description graphicsDeviceTypes The array of graphics APIs to match to. Description Enable or disable shader keyword filter attribu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a8e7a4b55bc
unity_docs
ui
What is `UIElements.BaseSlider_1.movableUssClassName` in Unity? Explain its purpose and usage.
BaseSlider<T0>.movableUssClassName public static string movableUssClassName ; Description USS class name on the dragger that indicates it is currently controlled by NavigationMoveEvent . When the slider detects move events aligned with the slider's direction, it adjusts the slider's value. If it detects a na...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_63713e504c1e
unity_docs
editor
Show me a Unity C# example demonstrating `iOS.Xcode.PBXProject.GetBuildPhaseName`.
n phaseGuid GUID of the phase. Returns string The build phase name if it's defined. Description Returns the name of the build phase with the specified GUID. For shell script and copy file build phases, the name is returned. For all the other phases, the type is returned. This is the same behavior as GetBuil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5de52034685
unity_docs
scripting
What is `AndroidJNI.SetStaticDoubleField` in Unity? Explain its purpose and usage.
AndroidJNI.SetStaticDoubleField Declaration public static void SetStaticDoubleField (IntPtr clazz , IntPtr fieldID , double val ); Description Sets the value of a static field in the specified object. Additional resources: Java Native Interface Specification (Oracle)
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_22c48f0f93d7_doc_8
github
scripting
What does `Dispose` do in this Unity script? Explain its purpose and signature.
Completes current running job, if there is any, remove all job providers and clears up used memory.This is called automatically when all job providers are unregistered or when the manager is finalized.You shouldn't need to call this manually at any point. Signature: ```csharp public void Dispose() ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_36c2c80c74b3
unity_docs
scripting
What is `Windows.WebCam.VideoCapture.StopVideoModeAsync` in Unity? Explain its purpose and usage.
VideoCapture.StopVideoModeAsync Declaration public void StopVideoModeAsync ( Windows.WebCam.VideoCapture.OnVideoModeStoppedCallback onVideoModeStoppedCallback ); Parameters Parameter Description onVideoModeStoppedCallback This callback will be invoked once video mode has been deactivated. Description Asyn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_56e8afd0f486
unity_docs
rendering
In Unity's 'Lightmap data format', what is 'HDR lightmap support' and how does it work?
You can use HDR lightmaps on Windows, Mac, Linux, iOS, tvOS, and Android. To control the encoding/compression of the lightmaps for these platforms, go to Edit > Project Settings > Player > Other Settings > Lightmap Encoding . Choosing High Quality will enable HDR lightmap support, whereas Normal Quality will switch to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_843f84e90141
unity_docs
physics
What is `Collider2D.sharedMaterial` in Unity? Explain its purpose and usage.
Collider2D.sharedMaterial public PhysicsMaterial2D sharedMaterial ; Description The PhysicsMaterial2D that is applied to this collider. If no PhysicsMaterial2D is specified then the Rigidbody2D.sharedMaterial on the Rigidbody2D that the collider is attached to is used. If the collider is not attached ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_10730d7aab72
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUILayout.EndBuildTargetSelectionGrouping`.
EditorGUILayout.EndBuildTargetSelectionGrouping Declaration public static void EndBuildTargetSelectionGrouping (); Description Close a group started with BeginBuildTargetSelectionGrouping. See Also: EditorGUILayout.BeginBuildTargetSelectionGrouping . Build Target Selection Group ```csharp using UnityEditor;p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16107a1e09dc
unity_docs
math
What is `Plane.SetNormalAndPosition` in Unity? Explain its purpose and usage.
Plane.SetNormalAndPosition Declaration public void SetNormalAndPosition ( Vector3 inNormal , Vector3 inPoint ); Parameters Parameter Description inNormal The plane's normal vector. inPoint A point that lies on the plane. Description Sets a plane using a point that lies within it along with a normal t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2572ed537217
unity_docs
scripting
In Unity's 'Create high-precision occlusion areas', what is 'Using an Occlusion Area component to define a View Volume' and how does it work?
Add an Occlusion Area component to an empty GameObject in your Scene In the Inspector window, configure the Size property so that the bounding volume covers the desired area In the Inspector window, enable Is View Volume
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a79052073b88
unity_docs
scripting
What is `Handles.SphereHandleCap` in Unity? Explain its purpose and usage.
Handles.SphereHandleCap Declaration public static void SphereHandleCap (int controlID , Vector3 position , Quaternion rotation , float size , EventType eventType ); Parameters Parameter Description controlID The control ID for the handle. position The position of the handle in the space of Handl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a33a2f7593b7
unity_docs
editor
Give me an overview of the `MenuCommand` class in Unity.
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_man_f1b49132fc75
unity_docs
rendering
Explain 'Graphics performance and profiling in URP' in Unity.
Resources for understanding and improving rendering performance in the Universal Render Pipeline (URP). Page Description Understanding performance Understand how the performance of your project depends on the Universal Render Pipeline (URP) features you use or enable, what your scenes contain, and which platforms you t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c7e5a2e1034
unity_docs
rendering
What is `Rendering.ShaderPropertyFlags.MainColor` in Unity? Explain its purpose and usage.
ShaderPropertyFlags.MainColor Description Signifies that value of this property contains the main color of the Material. This flag corresponds to the [MainColor] ShaderLab Properties attribute . By default, Unity considers a color with the property name name "_Color" to be the main color. Use the [MainColor] ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f64fe7ad005
unity_docs
scripting
Give me an overview of the `Mesh` class in Unity.
Mesh class in UnityEngine / Inherits from: Object / Implemented in: UnityEngine.CoreModule Description A class that allows you to create or modify meshes. Meshes contain vertices and multiple triangle arrays. Conceptually, all vertex data is stored in separate arrays of the same size. For example, if you hav...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_66ca7e28cdf9
unity_docs
ui
Give me an overview of the `TextAlignment` class in Unity.
TextAlignment enumeration Description How multiline text should be aligned. This is used by the TextMesh.alignment property. Properties Property Description Left Text lines are aligned on the left side. Center Text lines are centered. Right Text lines are aligned on the right side.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_381d8e7ff0b0
unity_docs
rendering
What is `ShadowmaskMode.Shadowmask` in Unity? Explain its purpose and usage.
ShadowmaskMode.Shadowmask Description Static shadow casters won't be rendered into real-time shadow maps. All shadows from static casters are handled via Shadowmasks and occlusion from Light Probes. Additional resources: QualitySettings.shadowmaskMode , QualitySettings.shadowDistance .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6232ff17ccc
unity_docs
animation
What is `AnimatorOverrideController.GetOverrides` in Unity? Explain its purpose and usage.
AnimatorOverrideController.GetOverrides Declaration public void GetOverrides (List<KeyValuePair<AnimationClip,AnimationClip>> overrides ); Parameters Parameter Description overrides Array to receive results. Description Gets the list of Animation Clip overrides currently defined in this Animator Override C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7c3ff1713c58
unity_docs
scripting
What is `AndroidJNI.DeleteGlobalRef` in Unity? Explain its purpose and usage.
AndroidJNI.DeleteGlobalRef Declaration public static void DeleteGlobalRef (IntPtr obj ); Description Deletes the global reference pointed to by obj . Additional resources: Java Native Interface Specification (Oracle)
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_38de65cbcfd9
unity_docs
scripting
Show me a Unity C# example demonstrating `Component.TryGetComponent`.
omponent or null . Returns bool Returns true if the component is found, false otherwise. Description Gets the component of the specified type, if it exists. TryGetComponent attempts to retrieve the component of the given type. The notable difference compared to GameObject.GetComponent is that this metho...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a5889bb29b1c_doc_10
github
scripting
What does `Erase` do in this Unity script? Explain its purpose and signature.
Erases GameObjects in a given position within the selected layers.The GameObjectBrush overrides this to provide GameObject erasing functionality.Grid used for layout.Target of the erase operation. By default the currently selected GameObject.The coordinates of the cell to erase data from. Signature: ```csharp public o...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_8e1912d8dd91
unity_docs
physics
In Unity's 'Set up forensic debugging for Unity', what is 'Force applications to create a dump file' and how does it work?
Note: These instructions apply to Windows Standalone and Universal Windows platforms when running on desktop. To make your applications produce a dump file when they run into an issue: Open the Windows registry. Navigate to HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting . Create a LocalDumps key ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca7011ce9a81
unity_docs
editor
What is `SceneManagement.EditorSceneManager.MarkAllScenesDirty` in Unity? Explain its purpose and usage.
EditorSceneManager.MarkAllScenesDirty Declaration public static void MarkAllScenesDirty (); Description Mark all the loaded Scenes as modified. This function marks all the currently loaded Scenes in the Editor as modified (having unsaved changes).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_23d9d293e5e8
unity_docs
animation
What is `Animations.AnimatorStateTransition` in Unity? Explain its purpose and usage.
AnimatorStateTransition class in UnityEditor.Animations / Inherits from: Animations.AnimatorTransitionBase Description Transitions define when and how the state machine switch from one state to another. AnimatorStateTransition always originate from an Animator State (or AnyState) and have timing parameters. A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5b9c5df9525
unity_docs
editor
What are the parameters of `Handles.FreeRotateHandle` in Unity?
Returns Quaternion The new rotation 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 an unconstrained rotation handle. The handle can rotate freely on all axes. The rotation gizmo has no visibl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_64915df37c46
unity_docs
math
What is `Search.QueryEngine_1` in Unity? Explain its purpose and usage.
QueryEngine<T0> class in UnityEditor.Search Description A QueryEngine defines how to build a query from an input string. It can be customized to support custom filters and operators. <TData>: The filtered data type. ```csharp using System.Collections.Generic; using System.Linq; using UnityEditor; using UnityEdit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75d69cf140b7
unity_docs
physics
What is `Physics2D.DefaultRaycastLayers` in Unity? Explain its purpose and usage.
Physics2D.DefaultRaycastLayers public static int DefaultRaycastLayers ; Description Layer mask constant that includes all layers participating in raycasts by default. The value of the mask is the bitwise complement of the IgnoreRaycastLayer mask. Additional resources: Raycast , IgnoreRaycastLayer , AllLaye...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_817aa3c1333c
unity_docs
ui
What is `Viewpoint_1` in Unity? Explain its purpose and usage.
Viewpoint<T0> class in UnityEditor Description Defines a Viewpoint that can be selected from the Cameras overlay. Use this base class with ICameraLensData to define a Viewpoint and expose a component in the Cameras overlay. If you expose a component in the Cameras overlay, you can use the Cameras overlay to loo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_73272b24be31
unity_docs
editor
In Unity's 'Player Accounts', what is 'Compatible with Unity' and how does it work?
These package versions are available in Unity version 6000.0: Documentation location: State Versions available: com.unity.services.playeraccounts@1.0 compatible 1.0.0-pre.1, 1.0.0-pre.2 com.unity.services.playeraccounts@0.1 compatible 0.1.0-preview com.unity.services.playeraccounts@0.0 compatible 0.0.1-preview, 0.0.2-p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6b1115cd930a
unity_docs
rendering
Explain 'Configure when Unity uses a shader' in Unity.
Resources for using #pragma and Tag blocks in ShaderLab to configure when Unity compiles and runs a shader . Page Description Set the rendering pipeline and render pass for a shader Use a Tag statement to set the render pipeline and render order for a shader. Set a shader to require a package Use a PackageRequirements ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4decbb36e4d6
unity_docs
physics
What is `SimulationStage` in Unity? Explain its purpose and usage.
SimulationStage enumeration Description A flag enum to determine which simulation stages to run. Additional resources: Physics.RunSimulationStage, PhysicsScene.RunSimulationStage. Properties Property Description None Shorthand for none of the SimulationStages. PrepareSimulation This stage prepares the physics...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fe2900c29807
unity_docs
math
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetricsFilters.SetStateFilter` in Unity? Explain its purpose and usage.
AsyncReadManagerMetricsFilters.SetStateFilter Declaration public void SetStateFilter ( Unity.IO.LowLevel.Unsafe.ProcessingState _state ); Declaration public void SetStateFilter (ProcessingState[] _states ); Parameters Parameter Description _state ProcessingState to filter by. Summary will include read...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8d4ea3533b32
unity_docs
editor
In Unity's 'Import Activity window introduction', what is 'Open the Import Activity window' and how does it work?
To open the Import Activity window: Go to Window > Analysis > Import Activity . You can also open the Import Activity window directly from an asset, which causes the window to immediately display the import details for the selected asset. To open the window from an asset choose from the following options: Right-click a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_22c48f0f93d7_doc_6
github
scripting
What does `GetData` do in this Unity script? Explain its purpose and signature.
Get a copy of the job data from the last processed frame for .Since update job managers use double buffering for the data, you can access a copy of the last processed data at any time, even while jobs are scheduled and/or processing.Calling this with an unregistered provider returns provider.InitialJobData. Signature:...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_61b4a1ed7a4c
unity_docs
scripting
What is `Accessibility.AccessibilitySettings.isBoldTextEnabled` in Unity? Explain its purpose and usage.
AccessibilitySettings.isBoldTextEnabled public static bool isBoldTextEnabled ; Description Checks whether or not bold text is enabled in the system settings. For all the supported platforms, refer to AccessibilitySettings . For Android, this requires at least API level 31. However, it might not be suppo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_12b55322e9ec
unity_docs
scripting
What is `Playables.PlayableOutput` in Unity? Explain its purpose and usage.
PlayableOutput struct in UnityEngine.Playables / Implemented in: UnityEngine.CoreModule Implements interfaces: IPlayableOutput Description See: IPlayableOutput . Static Properties Property Description Null Returns an invalid PlayableOutput.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32002c261671
unity_docs
physics
What is `JointSuspension2D.frequency` in Unity? Explain its purpose and usage.
JointSuspension2D.frequency public float frequency ; Description The frequency at which the suspension spring oscillates. The suspension spring will oscillate with a certain frequency as forces are added and removed from it. A damping ratio can be set to cause this oscillation to die down over time.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bfca84851bfb
unity_docs
editor
What is `BuildAssetBundlesParameters.bundleDefinitions` in Unity? Explain its purpose and usage.
BuildAssetBundlesParameters.bundleDefinitions public AssetBundleBuild[] bundleDefinitions ; Description Array defining the name and contents of each AssetBundle. (optional) An array of AssetBundleBuild structs that define the names and contents of each AssetBundle, e.g. the "Build Map". When provided Unity ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_30022f4962ac
unity_docs
rendering
What is `ShaderUtil.GetCallableShaderParamSize` in Unity? Explain its purpose and usage.
ShaderUtil.GetCallableShaderParamSize Declaration public static int GetCallableShaderParamSize ( Rendering.RayTracingShader s , int shaderIndex ); Parameters Parameter Description s The RayTracingShader instance. shaderIndex The callable Shader index for which to retrieve the parameter size. Returns ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_87af80c85c0d
unity_docs
physics
Explain 'Create custom binding types' in Unity.
You can create custom binding types to extend the runtime binding system. To create a custom binding type, create a class and inherit it from the CustomBinding class. ## Register and unregister binding objects The CustomBinding is like the IBinding interface, which allows you to register multiple binding instances in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b6b5ed4dc682
unity_docs
ui
What are the parameters of `GUI.BringWindowToFront` in Unity?
Description Bring a specific window to front of the floating windows. ```csharp // Draws 2 overlapped windows and when clicked on 1 window's button // Brings the other window to the front.using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { private Rect windowRect = new Rect(20, 2...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0ed0bb530692
unity_docs
input
What is `XR.InputFeatureUsage` in Unity? Explain its purpose and usage.
InputFeatureUsage struct in UnityEngine.XR / Implemented in: UnityEngine.XRModule Description Defines a generic usage that maps to an input feature on a device. Use the As method to turn into a generic usage. Properties Property Description name The string name of this usage feature; used internally to map t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_251389e7d88e
unity_docs
editor
What is `iOS.Xcode.PBXProject.AddRemotePackageReferenceAtRevision` in Unity? Explain its purpose and usage.
PBXProject.AddRemotePackageReferenceAtRevision Declaration public string AddRemotePackageReferenceAtRevision (string url , string revision ); Parameters Parameter Description url The URL of the repository. revision The ID of the commit. Returns string Returns the GUID of the remote package reference. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_53416428e856
unity_docs
ui
In Unity's 'ListView', what is 'ListView versus ScrollView' and how does it work?
You can use a ScrollView control to create the same functionalities as using a ListView. However, a ListView is more efficient than a ScrollView when you do the following: Populate list items Manage item height Bind and unbind to objects Instantiate the number of visual elements required to fill a page Recycle visual e...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9a46ea1acf3f
unity_docs
xr
In Unity's 'Asset Loading Profiler module reference', what is 'Chart categories' and how does it work?
The Asset Loading Profiler module’s chart is divided into different categories. To change the order of the categories in the chart, drag them in the chart’s legend. You can also click a category’s colored legend to toggle its display. For more information on how to use the Profiler window, refer to Getting started with...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_48974c44d4f4
unity_docs
input
What is `UIElements.IValueField_1` in Unity? Explain its purpose and usage.
IValueField<T0> interface in UnityEngine.UIElements Description Base interface for UIElements text value fields. Properties Property Description value The value of the field. Public Methods Method Description ApplyInputDeviceDelta Applies the values of a 3D delta and a speed from an input device. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ae17f2d63177
unity_docs
scripting
What is `Experimental.Rendering.GraphicsStateCollection.WarmUp` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsStateCollection.WarmUp Declaration public Unity.Jobs.JobHandle WarmUp ( Unity.Jobs.JobHandle dependency ); Parameters Parameter Description dependency Job to wait for. Returns JobHandle Handle to prewarming...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1099d9786d1
unity_docs
editor
What are the parameters of `EditorGUILayout.RectField` in Unity?
Returns Rect The value entered by the user. Description Make an X, Y, W & H field for entering a Rect . Capture the RectField sizes. ```csharp using UnityEditor; using UnityEngine;public class RectFieldExample : EditorWindow { static Rect pos; [MenuItem("Examples/RectField Example")] static void rectFieldExa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c06668dabd0
unity_docs
rendering
What is `CameraClearFlags.Depth` in Unity? Explain its purpose and usage.
CameraClearFlags.Depth Description Clear only the depth buffer. This will leave colors from the previous frame or whatever was displayed before. Additional resources: Camera.clearFlags property, camera component .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4e4d2979d49b
unity_docs
scripting
What is `Bounds.extents` in Unity? Explain its purpose and usage.
Bounds.extents public Vector3 extents ; Description The extents of the Bounding Box. This is always half of the size of the Bounds. Note: If Bounds.extents has a negative value for any axis, Bounds.Contains always returns False. ```csharp //Attach this script to a visible GameObject. //Click on the G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3f5aefa27757
unity_docs
editor
What are the parameters of `iOS.Xcode.PBXProject.BuildConfigByName` in Unity?
Returns string The GUID of the build configuration or null if it doesn't exist. Description Returns the GUID of build configuration with the given name for the specific target. Returns Null if such configuration does not exist. ```csharp using UnityEditor; using System.IO; using UnityEditor.Callbacks; using UnityEditor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_717ce69d95c2
unity_docs
scripting
What is `Color.ToString` in Unity? Explain its purpose and usage.
Color.ToString Declaration public string ToString (); Declaration public string ToString (string format ); Declaration public string ToString (string format , IFormatProvider formatProvider ); Parameters Parameter Description format A numeric format string. formatProvider An object that specifies...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e6e5a05b8548
unity_docs
rendering
In Unity's 'Platform-specific texture overrides panel reference', what is 'Platform-specific overrides tabs' and how does it work?
The platform-specific override tabs let you override the settings in the Default tab for specific platforms. For more information about build platforms, refer to Build Profiles window reference . Property Description Max Size Sets the maximum dimensions of the imported texture in pixels. Resize Algorithm Sets the algor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0ad47fed7980
unity_docs
scripting
What is `Application.platform` in Unity? Explain its purpose and usage.
Application.platform public static RuntimePlatform platform ; Description Returns the platform the game is running on (Read Only). Use this property if you need to do some platform dependent work. ```csharp using UnityEngine;public class ExampleClass : MonoBehaviour { void Start() { if (Application.platfo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0f6525b668a8
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUILayout.GradientField`.
t properties. Any values passed in here will override settings defined by the style . Additional resources: GUILayout.Width , GUILayout.Height , GUILayout.MinWidth , GUILayout.MaxWidth , GUILayout.MinHeight , GUILayout.MaxHeight , GUILayout.ExpandWidth , GUILayout.ExpandHeight . Returns Gradient The gradi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_715aa7ce981e
unity_docs
math
Show me a Unity C# example demonstrating `Mathf.Asin`.
Mathf.Asin Declaration public static float Asin (float f ); Description Returns the arc-sine of f - the angle in radians whose sine is f . ```csharp using UnityEngine;public class ScriptExample : MonoBehaviour { void Start() { print(Mathf.Asin(0.5f)); } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f522b91ce703_doc_20
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Represents an object which can receive nine arguments as part of its initialization process.Base interface of . Signature: ```csharp public interface INineArguments ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_43857ddc6db8
unity_docs
rendering
In Unity's 'Set up transparent videos in Unity', what is 'Change your Video Clip settings' and how does it work?
If your transparent video’s codec is Apple ProRes 4444: Select your imported video clip. The Video Clip Importer Inspector window displays. Enable Transcode . Enable Keep Alpha . As a result, your ProRes video is ready for use in Unity.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b63ebc058e0b
unity_docs
scripting
What is `Experimental.Rendering.ScriptableRuntimeReflectionSystemSettings.system` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ScriptableRuntimeReflectionSystemSettings.system public static Experimental.Rendering.IScriptableRuntimeReflectionSystem system ; Description The current scriptable runtime reflection system instance. Set this property in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_face82c0f81f
unity_docs
editor
Show me a Unity C# example demonstrating `BuildAssetBundleOptions.IgnoreTypeTreeChanges`.
BuildAssetBundleOptions.IgnoreTypeTreeChanges Description Ignore the type tree changes when doing the incremental build check. This allows you to ignore the type tree changes when doing the incremental build check. With this flag set, if the included assets haven't change but type trees have changed, the target ass...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b79359bc5702
unity_docs
rendering
What is `Rendering.BatchDrawCommand` in Unity? Explain its purpose and usage.
BatchDrawCommand struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Represents a draw command for a BatchRendererGroup . Properties Property Description batchID The batch ID that this draw command uses. Determines the metadata values that are available to a shader. flags ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_574a5ea60b24
unity_docs
rendering
What is `ParticleSystem.MinMaxCurve.constantMin` in Unity? Explain its purpose and usage.
ParticleSystem.MinMaxCurve.constantMin public float constantMin ; Description Set a constant for the lower bound. Useful when ParticleSystem.MinMaxCurve.mode is set to ParticleSystemCurveMode.TwoConstants .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_050af557370c
unity_docs
scripting
What is `ArticulationBody.maxDepenetrationVelocity` in Unity? Explain its purpose and usage.
ArticulationBody.maxDepenetrationVelocity public float maxDepenetrationVelocity ; Description The maximum velocity of an articulation body when moving out of penetrating state. Use this property to move bodies out of a colliding state more smoothly than the default. Unit of measurement - m/s (meters per secon...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e6855f556f24
unity_docs
scripting
What are the parameters of `Physics.ComputePenetration` in Unity?
Returns bool True, if the colliders overlap at the given poses. Description Compute the minimal translation required to separate the given colliders apart at specified poses. Translating the first collider by direction * distance will separate the colliders apart if the function returned true. Otherwise, direction and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b633549cec9b
unity_docs
scripting
What is `Unity.Properties.IProperty.GetAttribute` in Unity? Explain its purpose and usage.
IProperty.GetAttribute Declaration public TAttribute GetAttribute (); Returns TAttribute The attribute of the given type for this property. Description Returns the first attribute of the given type.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_88982845a980
unity_docs
physics
What is `Joint.autoConfigureConnectedAnchor` in Unity? Explain its purpose and usage.
Joint.autoConfigureConnectedAnchor public bool autoConfigureConnectedAnchor ; Description Should the connectedAnchor be calculated automatically? If this is enabled, then the connectedAnchor property will be calculated automatically to match the global position of the anchor property. This is the default ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ddbf5a28d033
unity_docs
scripting
What are the parameters of `Search.QueryEngine_1.TryGetFilter` in Unity?
Returns bool Returns true if the filter is retrieved or false if the filter does not exist. Description Get a filter by its token. This method tries to retrieve a filter by its token. If it exists, it will be put in the output parameter "filter" and the function returns true. If the filter does not exist, the parameter...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_68688ab84fe3
unity_docs
scripting
What is `SceneView.FrameSelected` in Unity? Explain its purpose and usage.
SceneView.FrameSelected Declaration public bool FrameSelected (); Declaration public bool FrameSelected (bool lockView ); Parameters Parameter Description lockView Whether the view should be locked to the selection. Returns bool Returns true if the current selection fits in the Scene view. Returns fa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_44f1d2e5399d
unity_docs
rendering
In Unity's 'Introduction to the BatchRendererGroup API in URP', what is 'Platform compatibility' and how does it work?
Unity supports BRG on: Windows using DirectX 11 Windows using DirectX 12 Windows using Vulkan Universal Windows Platform Linux using Vulkan macOS using Metal iOS Android (Vulkan and OpenGL ES 3.x) PlayStation 4 PlayStation 5 Xbox One Xbox Series X and Xbox Series S Nintendo Switch
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_713226397aeb
unity_docs
editor
What is `VideoCodec` in Unity? Explain its purpose and usage.
VideoCodec enumeration Description Choose the video codec to use to import video clips. Use this enum to set VideoImporterTargetSettings.codec . A video codec compresses (encodes) or decompresses (decodes) video data to reduce the file size but avoid reduction of quality as much as possible. For Unity to conside...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8c1a169fa1a
unity_docs
audio
What is `AudioSource.spatialize` in Unity? Explain its purpose and usage.
AudioSource.spatialize public bool spatialize ; Description Enables or disables spatialization. Custom spatializer effects improve the realism of sound propagation by incorporating the binaural head-related transfer function (HRTF) such that the listener can better sense the directionality of the sound through...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2bba5a420fc8
unity_docs
editor
What is `VersionControl.VersionControlManager` in Unity? Explain its purpose and usage.
VersionControlManager class in UnityEditor.VersionControl Description Manages version control systems. This class allows you to enumerate the available version control systems, get the VersionControlObject for the currently active VCS, or switch to a different one. Additional resources: VersionControlObject . ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57b97146f97f
unity_docs
input
What is `Color.RGBToHSV` in Unity? Explain its purpose and usage.
Color.RGBToHSV Declaration public static void RGBToHSV ( Color rgbColor , out float H , out float S , out float V ); Parameters Parameter Description rgbColor An input color. H Output variable for hue. S Output variable for saturation. V Output variable for value. Description Calculates the hue, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.