id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_sr_8dcdf61932af
unity_docs
xr
What is `Search.SearchService` in Unity? Explain its purpose and usage.
SearchService class in UnityEditor.Search Description Principal Search API to initiate searches and fetch results. Make sure to check SearchService.Request for a complete list of all the different ways to execute a search request. ```csharp using System.Linq; using System.Collections.Generic; using UnityEditor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_09f4206c17c6
github
scripting
Write a Unity C# script called CSV Generator
```csharp using System; using System.Collections.Generic; using System.Text; using TinyCSV; using UnityEngine; namespace GameUtil.Config { /// <summary> /// csv与class文件互相转换 /// </summary> public static class CSVGenerator { private const string CLASS_HEAD_TEMPLATE = @"using System; using Sys...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_522d7ed7e37d
unity_docs
scripting
What is `UIElements.DragUpdatedEvent.GetPooled` in Unity? Explain its purpose and usage.
DragUpdatedEvent.GetPooled Declaration public static UIElements.DragUpdatedEvent GetPooled ( Event systemEvent ); Parameters Parameter Description systemEvent An IMGUI drag updated event. Returns DragUpdatedEvent An initialized event. Description Gets an event from the event pool and initializes ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f5673f7ea789_doc_1
github
scripting
What does `IsVRActive` do in this Unity script? Explain its purpose and signature.
True when an XR device (HMD) is active and tracking. Signature: ```csharp public bool IsVRActive => XRSettings.isDeviceActive; ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_c3080669c064
unity_docs
rendering
In Unity's 'Video Clip Importer reference', what is 'Video Clip Importer settings' and how does it work?
The following settings are available in the Inspector window when you select a video file in your project. Property Description sRGB (Color Texture) Choose whether the VideoPlayer converts sRGB to Linear color space when it loads the video data into textures. Unity enables this setting by default because most video cli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5b52e91992c2
unity_docs
rendering
Show me a Unity C# example demonstrating `TrailRenderer.generateLightingData`.
TrailRenderer.generateLightingData public bool generateLightingData ; Description Configures a trail to generate Normals and Tangents. With this data, Scene lighting can affect the trail via Normal Maps and the Unity Standard Shader, or your own custom-built Shaders. ```csharp using UnityEngine; using System.C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_01f2d15fecf1
unity_docs
math
What is `Rendering.VisibleLight` in Unity? Explain its purpose and usage.
VisibleLight struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Holds data of a visible light. After ScriptableRenderContext.Cull is done, CullingResults.visibleLights will contain an array of lights that are visible. The visible light structure contains packed information ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_783d9eecdeed
unity_docs
editor
What is `SceneManagement.EditorSceneManager.SaveModifiedScenesIfUserWantsTo` in Unity? Explain its purpose and usage.
EditorSceneManager.SaveModifiedScenesIfUserWantsTo Declaration public static bool SaveModifiedScenesIfUserWantsTo (Scene[] scenes ); Parameters Parameter Description scenes Scenes that should be saved if they are modified. Returns bool Returns true if the user clicked Save or Don't Save to indicate t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b7b8c8f3384e
unity_docs
ui
Explain 'ToolbarSearchField' in Unity.
A ToolbarSearchField is an Editor-only control that serves as a search field. It’s a TextField with predefined styles that matches the Toolbar style. ## Create a ToolbarSearchField You can create a ToolbarSearchField with UI Builder, UXML, or C#. The following C# example creates a ToolbarSearchField a placeholder tex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_44863acade36_doc_5
github
scripting
What does `TryGetLatLongAltitude` do in this Unity script? Explain its purpose and signature.
Try to get the resultant transformed position of this Positioner as a LatLongAltitude.The method returns false if the resultant transformed position is not currently defined - in whichcase IsTransformedPointDefined would also return false.To transform out_latLongAlt into a world-space translation, see SpacesApi.Geograp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_67f736c62791
unity_docs
scripting
What is `Experimental.GraphView.EdgeDragHelper_1.edgeCandidate` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeDragHelper<T0>.edgeCandidate public Experimental.GraphView.Edge edgeCandidate ; Description The edge being dragged.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8523b1f35148
unity_docs
scripting
What is `Android.AndroidAssetPacks.RemoveAssetPack` in Unity? Explain its purpose and usage.
AndroidAssetPacks.RemoveAssetPack Declaration public static void RemoveAssetPack (string assetPackName ); Parameters Parameter Description assetPackName The name of the Android asset pack to remove. Description Removes Android asset pack. This method directly wraps Google's PlayCore plugin API. If the Pla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39d5dfcb2224
unity_docs
ui
What are the parameters of `UIElements.VisualElementExtensions.StretchToParentSize` in Unity?
Description Aligns a VisualElement's left, top, right and bottom edges with the corresponding edges of its parent. This method provides a way to set the following styles in one operation: - IStyle.position is set to Position.Absolute - IStyle.left is set to 0 - IStyle.top is set to 0 - IStyle.right is set to 0 - IS...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_030d7fb2e2c9
unity_docs
scripting
What is `AI.NavMeshObstacle.size` in Unity? Explain its purpose and usage.
NavMeshObstacle.size public Vector3 size ; Description The size of the obstacle, measured in the object's local space. The size will be scaled by the transform's scale. ```csharp using UnityEngine; using UnityEngine.AI; using System.Collections;public class ExampleClass : MonoBehaviour { void Start() { Na...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55f21aa0face
unity_docs
physics
Give me an overview of the `JointTranslationLimits2D` class in Unity.
JointTranslationLimits2D struct in UnityEngine / Implemented in: UnityEngine.Physics2DModule Description Motion limits of a Rigidbody2D object along a SliderJoint2D. Additional resources: Rigidbody2D class, SliderJoint2D class. Properties Property Description max Maximum distance the Rigidbody2D object ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1508d8be65e1_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The interactor that drives the display and placement of the pointer object. Signature: ```csharp public ClimbTeleportInteractor climbTeleportInteractor ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_662ef717be54
unity_docs
physics
What is `XR.MeshGenerationResult` in Unity? Explain its purpose and usage.
MeshGenerationResult struct in UnityEngine.XR / Implemented in: UnityEngine.XRModule Description Contains event information related to a generated mesh. This struct is used by the XRMeshSubsystem to provide information about the result of XRMeshSubsystem.GenerateMeshAsync . Properties Property Descript...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2fabe6e31f5a
unity_docs
editor
Show me a Unity C# example demonstrating `iOS.Xcode.PBXProject.AddFileToBuildSection`.
for the given native target on specific build section. The function is equivalent to AddFileToBuild except that a specific build section is defined. In projects containing multiple native targets, you can configure a single file or folder reference to build in all, some, or none of the targets. The file or folder re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_14d77dcb189a
unity_docs
scripting
What is `Experimental.GraphView.GraphView.FrameSelection` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphView.FrameSelection Declaration public Experimental.GraphView.EventPropagation FrameSelection (); Returns EventPropagation Continue if no elements selected, Stop otherwise. Description Focus view on currently sel...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_058ecc4aa985
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R8_UNorm` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R8_UNorm Description A one-component, 8-bit unsigned normalized format that has a single 8-bit R component.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c709c61153e
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.GetImporterType`.
Returns the type of importer associated with an asset without loading the asset. This method allows you to determine which importer is associated with an asset. This method is more efficient than AssetImporter.GetAtPath , which also loads the object. If you need to check a large number of asset importers at once, you...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_506b2ba298eb
unity_docs
editor
What is `EditorUserBuildSettings.symlinkSources` in Unity? Explain its purpose and usage.
EditorUserBuildSettings.symlinkSources public static bool symlinkSources ; Description Symlink sources when generating the project. You can also set this property in the Unity Editor using the Symlink Sources setting on the Build Profiles window for Android and iOS. Additional resources: BuildOptions.Symli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_de3cf048643b
unity_docs
networking
In Unity's 'Collecting performance data on an Android device', what is 'Enabling remote profiling' and how does it work?
To enable remote profiling, follow these steps: Connect the device to your WiFi network. The Profiler uses a local WiFi network to send profiling data from your device to the Unity Editor. Attach your device to your computer via cable. Open the Build Profiles window (menu: File > Build Profiles ). Enable the Developmen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_154bca798534
unity_docs
scripting
What is `EditorApplication.ProjectWindowItemCallback` in Unity? Explain its purpose and usage.
EditorApplication.ProjectWindowItemCallback Declaration public delegate void ProjectWindowItemCallback (string guid , Rect selectionRect ); Description Delegate to be called for every visible list item in the ProjectWindow on every OnGUI event. Use this if you if you want to extend the functionality of the P...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a1e172782681
unity_docs
ui
What is `GUIStyle.none` in Unity? Explain its purpose and usage.
GUIStyle.none public static GUIStyle none ; Description Shortcut for an empty GUIStyle. This style contains no decoration and just renders everything in the default font. ```csharp using UnityEngine;public class Example : MonoBehaviour { void OnGUI() { // Make a button with no decoration GUI.Button(new ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b0fdbc4aad60
unity_docs
rendering
What is `Material.FindPass` in Unity? Explain its purpose and usage.
Material.FindPass Declaration public int FindPass (string passName ); Description Returns the index of the pass passName . Returns the index of the pass passName . -1 if it does not exist.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc0273005071
unity_docs
physics
What is `IMGUI.Controls.JointAngularLimitHandle.xMin` in Unity? Explain its purpose and usage.
JointAngularLimitHandle.xMin public float xMin ; Description Returns or specifies the minimum angular motion about the x-axis. The value returned by this property depends on the current value of the xMotion property. If it is ConfigurableJointMotion.Locked , then it will always return 0. If it is Configurab...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c6326131e79b
unity_docs
rendering
In Unity's 'Occlusion culling', what is 'When to use occlusion culling' and how does it work?
To determine whether occlusion culling is likely to improve the runtime performance of your Project, consider the following: Preventing wasted rendering operations can save on both CPU and GPU time. Unity’s built-in occlusion culling performs runtime calculations on the CPU, which can offset the CPU time that it saves....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_da15fd25086b
unity_docs
scripting
What is `RuntimeInitializeLoadType.BeforeSceneLoad` in Unity? Explain its purpose and usage.
RuntimeInitializeLoadType.BeforeSceneLoad Description Callback invoked when the first scene's objects are loaded into memory but before Awake has been called. For more info on ordering see RuntimeInitializeOnLoadMethodAttribute . ```csharp // Demonstration of the RuntimeInitializeLoadType.BeforeSceneLoad attrib...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1f7a3187ca32
unity_docs
scripting
Show me a Unity C# example demonstrating `RectInt.zero`.
RectInt.zero public static RectInt zero ; Description Shorthand for writing new RectInt(0,0,0,0) . Additional resources: RectInt . ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { RectInt initialBox = RectInt.zero; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09488580dcc7
unity_docs
ui
What is `EditorTools.EditorToolContextAttribute` in Unity? Explain its purpose and usage.
EditorToolContextAttribute class in UnityEditor.EditorTools / Inherits from: EditorTools.ToolAttribute Description Registers an EditorToolContext as either a global context or a Component context for a specific target type. A Global tool context is always available in the toolbar menu. A Component tool co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c6ea5c70344
unity_docs
editor
What is `EditorBuildSettings.sceneListChanged` in Unity? Explain its purpose and usage.
EditorBuildSettings.sceneListChanged Description A delegate called whenever EditorBuildSettings.scenes is set. Used by any system that needs to be aware of updates to the Scenes list. Is only called if the Scenes array actually changes.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_21e243377d79
unity_docs
rendering
Explain 'Gradle project files' in Unity.
Gradle project files configure different aspects of your application, such as the modules to include and how to build them. The following table lists the Gradle project files that exist for Unity projects and describes the purpose of each one. Gradle project file Purpose Main Manifest Contains important metadata about ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_17be1dd64109
unity_docs
editor
What is `VersionControl.Provider.Resolve` in Unity? Explain its purpose and usage.
Provider.Resolve Declaration public static VersionControl.Task Resolve ( VersionControl.AssetList assets , VersionControl.ResolveMethod resolveMethod ); Parameters Parameter Description assets List of assets to resolve. resolveMethod How the assets should be resolved. Description Starts a task that...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6d8ef33fd0c
unity_docs
xr
What is `UnityEngine.VRModule` in Unity? Explain its purpose and usage.
UnityEngine.VRModule Description The VR module implements support for virtual reality devices in Unity. Classes Class Description XRDevice Contains all functionality related to a XR device. XRSettings Global XR related settings. XRStats Timing and other statistics from the XR subsystem. Enumerations Enumerat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a9b3b5c41bbe
unity_docs
scripting
What is `Unity.Properties.IListPropertyBagVisitor` in Unity? Explain its purpose and usage.
IListPropertyBagVisitor interface in Unity.Properties Description Interface for visiting property bags. Public Methods Method Description Visit Implement this method to accept visitation for a collection of properties.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ed9d014dd609
unity_docs
rendering
What is `Experimental.Rendering.GraphicsFormatUtility.ConvertToAlphaFormat` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormatUtility.ConvertToAlphaFormat Declaration public static Experimental.Rendering.GraphicsFormat ConvertToAlphaFormat ( Experimental.Rendering.GraphicsFormat format ); Description Input a GraphicsFormat to retur...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_da2eb381dbe4
unity_docs
editor
What is `TypeCache.FieldInfoCollection` in Unity? Explain its purpose and usage.
FieldInfoCollection struct in UnityEditor Description Represents a read-only collection of FieldInfo and implements an IList interface. Note: The collection is immutable for the duration of Unity domain lifecycle. All IList methods that might alter the collection always throw NotSupportedException . Properti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f642bf092922
unity_docs
rendering
What are the parameters of `AssetDatabase.GetCachedIcon` in Unity?
Description Retrieves an icon for the asset at the given asset path. ```csharp using System.Collections.Generic; using UnityEditor; using UnityEngine;public class AssetDatabaseExamples : MonoBehaviour { [MenuItem("AssetDatabase/Get Cached Icon Example")] public static void GetCachedIconExample() { v...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_51e131453798
unity_docs
physics
What is `Rigidbody.AddTorque` in Unity? Explain its purpose and usage.
Rigidbody.AddTorque Declaration public void AddTorque ( Vector3 torque , ForceMode mode = ForceMode.Force); Parameters Parameter Description torque Torque vector in world coordinates. mode The type of torque to apply. Description Adds a torque to the rigidbody. Force can be applied only to an acti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9be402f2ef03
unity_docs
editor
What is `SerializedProperty.GetArrayElementAtIndex` in Unity? Explain its purpose and usage.
SerializedProperty.GetArrayElementAtIndex Declaration public SerializedProperty GetArrayElementAtIndex (int index ); Description Returns the element at the specified index in the array. Additional resources: isArray , arraySize , Next . ```csharp using UnityEditor; using UnityEngine;public class ArrayExa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_98850f4b89e4
unity_docs
rendering
What is `LightTransport.PostProcessing.ReferenceProbePostProcessor.DeringSphericalHarmonicsL2` in Unity? Explain its purpose and usage.
ReferenceProbePostProcessor.DeringSphericalHarmonicsL2 Declaration public bool DeringSphericalHarmonicsL2 ( LightTransport.IDeviceContext context , BufferSlice<SphericalHarmonicsL2> shIn , BufferSlice<SphericalHarmonicsL2> shOut , int probeCount ); Parameters Parameter Description context Device context....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_abfe5cbdedaa
unity_docs
rendering
What is `DynamicGI.isConverged` in Unity? Explain its purpose and usage.
DynamicGI.isConverged public static bool isConverged ; Description Is precomputed Enlighten Realtime Global Illumination output converged? The GI system will process updates to lighting and update the Enlighten Realtime Global Illumination lightmaps. Updates can be triggered by Scene load, animating lights and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8e9d545a1f2
unity_docs
rendering
What is `ShaderKeywordFilter.SelectIfNotAttribute.ctor` in Unity? Explain its purpose and usage.
SelectIfNotAttribute Constructor Declaration public SelectIfNotAttribute (object condition , bool overridePriority , string filePath , int lineNumber , params string[] keywordNames ); Parameters Parameter Description condition Unity compares the data field to this value. The outcome determines the filter...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b28f7d402870
unity_docs
scripting
What is `Cache.ClearCache` in Unity? Explain its purpose and usage.
Cache.ClearCache Declaration public bool ClearCache (); Declaration public bool ClearCache (int expiration ); Parameters Parameter Description expiration The number of seconds that AssetBundles may remain unused in the cache. Returns bool Returns True when cache clearing succeeded. Description Re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c31c9c03210
unity_docs
math
Show me a Unity C# example demonstrating `Sprite.GetSecondaryTextures`.
size of the arrays passed in as parameters are less than the number of SecondarySpriteTexture used by the sprite, the arrays will not be resized and the results will be limited. If the size of the arrays passed in as parameters are bigger than the number of SecondarySpriteTexture used by the sprite, the number of e...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca5a65405587
unity_docs
physics
What is `PhysicsVisualizationSettings.GetShowPhysicsSceneMask` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.GetShowPhysicsSceneMask Declaration public static int GetShowPhysicsSceneMask (); Description Return a mask representing scenes that are enabled by display filter Get a mask representing scenes that are enabled by display filter
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_77a048fa81a3
unity_docs
scripting
In Unity's 'Search presets', what is 'Actions' and how does it work?
The context menu for the Presets search provider includes the following actions: Action Description Select Open the preset in the Inspector and Project windows. Open Open the preset in the Unity Editor or an external editor. Reimport For imported presets, reimports the preset from the source file. Reveal Opens the pres...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_46e83f97fbe4
unity_docs
scripting
What is `Playables.IPlayableAsset` in Unity? Explain its purpose and usage.
IPlayableAsset interface in UnityEngine.Playables Description Interface that permits a class to inject playables into a graph. Properties Property Description duration Duration in seconds. outputs A description of the PlayableOutputs generated by this asset. Public Methods Method Description CreatePlayabl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_407642746697
unity_docs
rendering
What is `Rendering.ScriptableRenderContext.BeginRenderPass` in Unity? Explain its purpose and usage.
ScriptableRenderContext.BeginRenderPass Declaration public void BeginRenderPass (int width , int height , int samples , NativeArray<AttachmentDescriptor> attachments , int depthAttachmentIndex ); Declaration public void BeginRenderPass (int width , int height , int volumeDepth , int samples , NativeArra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fee37c584594
unity_docs
editor
In Unity's 'The Simulator view', what is 'Toolbar' and how does it work?
The toolbar is at the top of the Simulator view and contains options that, along with the Control Panel , control the simulation. Control Description Game/Simulator view Use this drop-down menu to switch between the Simulator view and the Game view. Device selection drop-down menu Choose the device to simulate from the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_acca4ceaf47d
unity_docs
scripting
What are the parameters of `Grid.GetCellCenterWorld` in Unity?
Returns Vector3 Center of the cell transformed into world space coordinates. Description Get the logical center coordinate of a grid cell in world space. In a rectangular grid layout, a call to GridLayout.CellToWorld with Vector3Int parameter, returns a Vector3 coordinate that represents the bottom-left of the cell. Th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2bf3e009a35e
unity_docs
physics
Explain 'Create a custom build script' in Unity.
To customize how Unity makes a build, use BuildPipeline to perform a build, along with any pre-build and post-build steps that you need for your project. Launching a Player build from the Build Profiles window doesn’t trigger custom build scripts . You need to provide a way to invoke your script. The most common way to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b800a31890b4
unity_docs
scripting
What is `VersionControl.CompletionAction` in Unity? Explain its purpose and usage.
CompletionAction enumeration Description Different actions a version control task can do upon completion. Properties Property Description UpdatePendingWindow Update the list of pending changes when a task completes. OnChangeContentsPendingWindow Update the content of a pending changeset with the result of the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ea1acd6f1f70
unity_docs
editor
Explain 'Unity Editor interface' in Unity.
Understand the key tools and workflows of the Unity Editor. The Unity Editor is the main workspace you use to create, organize, and manage your application. Topic Description Navigating and managing the Unity Editor Navigate the Editor interface, use keyboard shortcuts, search for resources, and manage your workflow. U...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd6ac24623ba
unity_docs
physics
What is `PhysicsVisualizationSettings.GetShowTriggers` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.GetShowTriggers Declaration public static bool GetShowTriggers (); Description Should the triggers be considered by the display filter. Additional resources: Collider.isTrigger .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c2a71a0d33a
unity_docs
scripting
What is `TerrainDetailMeshWizard` in Unity? Explain its purpose and usage.
TerrainDetailMeshWizard class in UnityEditor / Inherits from: TerrainWizard Description Provides methods for displaying the detail mesh wizard. Derived class that manages the detail mesh wizards used for displaying and altering detail mesh data. Note: that this method derives from TerrainWizard. Additional...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_170a6e79267c
unity_docs
animation
What is `AnimatedValues.BaseAnimValue_1.value` in Unity? Explain its purpose and usage.
BaseAnimValue<T0>.value public T value ; Description Current value of the animation. Getting will return the current animated value. Setting will stop the animation and set the current value to value.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_47cdf73488d9
unity_docs
scripting
What is `Experimental.GraphView.Node` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Node class in UnityEditor.Experimental.GraphView / Inherits from: Experimental.GraphView.GraphElement Implements interfaces: ICollectibleElement Description Main GraphView node class. Properties Property Description expa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f8d2f34b1f26
unity_docs
editor
What is `IMGUI.Controls.ArcHandle.SetColorWithRadiusHandle` in Unity? Explain its purpose and usage.
ArcHandle.SetColorWithRadiusHandle Declaration public void SetColorWithRadiusHandle ( Color color , float fillColorAlpha ); Parameters Parameter Description color The color to use for the angle and radius control handles and the fill shape. fillColorAlpha The alpha value to use for fillColor . Descript...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c5564a9cc8a9_doc_2
github
scripting
What does `IsAR` do in this Unity script? Explain its purpose and signature.
Retrieve current Video See Through status.True: the current mode is AR. False: the current mode is VR. Signature: ```csharp public bool IsAR() ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_421253e5b657
unity_docs
rendering
What is `Rendering.LightUnit` in Unity? Explain its purpose and usage.
LightUnit enumeration Description The unit of a Light 's intensity. Additional resources: Light.lightUnit , light component . Properties Property Description Lumen The unit of luminous flux. Candela The base unit of luminous intensity in the International System of Units. Lux The unit of illuminance (lume...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3fb5d43a2024
unity_docs
rendering
What are the parameters of `LightTransport.BakeProgressState.SetTotalWorkSteps` in Unity?
Description Sets the total amount of work steps for the progress state. Increase the completed work steps using IncrementCompletedWorkSteps. Configures the total expected work for progress calculation. This value is used as the denominator when calculating progress percentages. The total should represent meaningful wor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2af0e1e78454
unity_docs
scripting
What is `Rendering.RenderStateBlock.rasterState` in Unity? Explain its purpose and usage.
RenderStateBlock.rasterState public Rendering.RasterState rasterState ; Description Specifies the new raster state. Unity applies these values to the GPU's render state if RenderStateBlock.mask includes a value of RenderStateMask.Raster . The default value is RasterState.defaultValue .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a477aa57261
unity_docs
scripting
What is `Experimental.GraphView.BlackboardField` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. BlackboardField class in UnityEditor.Experimental.GraphView / Inherits from: Experimental.GraphView.GraphElement Description GraphElement that represents a field of a Graph. Properties Property Description blackboard The ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_98de5c13d2e2
unity_docs
editor
Show me a Unity C# example demonstrating `PlayerSettings.GetScriptingDefineSymbols`.
PlayerSettings.GetScriptingDefineSymbols Declaration public static string GetScriptingDefineSymbols ( Build.NamedBuildTarget buildTarget ); Parameters Parameter Description buildTarget The NamedBuildTarget . Description Gets the array of symbols for script compilation for the build target you select. Sy...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ce681ae2e5c
unity_docs
scripting
What is `Search.ObjectField` in Unity? Explain its purpose and usage.
ObjectField class in UnityEditor.Search / Inherits from: UIElements.BaseField_1 Description Object field used with the advanced search picker. Static Properties Property Description singleLineHeight Default line height used to render the object field control. Properties Property Description objectType Ty...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d5b553a503be
unity_docs
xr
What is `iOS.OnDemandResources` in Unity? Explain its purpose and usage.
OnDemandResources class in UnityEngine.iOS / Implemented in: UnityEngine.CoreModule Description On Demand Resources API. Additional resources: OnDemandResources.PreloadAsync and OnDemandResourcesRequest . Static Properties Property Description enabled Indicates whether player was built with "Use On Deman...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_843436a1a35d
unity_docs
scripting
What are the parameters of `Vector3.Reflect` in Unity?
Description Reflects a vector off the plane defined by a normal vector. This method calculates the reflection vector using the following formula: B = A − 2 × N × A ⋅ N where A is the incoming vector and N defines the normal (perpendicular) vector of the reflection plane. The returned value is a vector of equal magnitud...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d8db4bbc0a0c
unity_docs
rendering
Show me a Unity C# example demonstrating `Texture2DArray.GetPixels`.
mpress compressed textures, and use memory to store the decompressed area. To get pixel data more quickly, use GetPixelData instead. If GetPixels fails, Unity throws an exception. GetPixels might fail if the array contains too much data. Use GetPixelData instead for very large textures. You can't use GetPixel ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_38e1fc17ecd9_doc_1
github
scripting
What does `GetAllAvailableEditorTypes` do in this Unity script? Explain its purpose and signature.
Get all types.Excluding default or sample types. Signature: ```csharp public static Type[] GetAllAvailableEditorTypes() ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_13da307f7dc9
unity_docs
editor
What are the parameters of `UIElements.DropdownMenu.InsertSeparator` in Unity?
Description Adds a separator line in the menu. The separator is added at the end of the specified index in the list. ```csharp using UnityEditor; using UnityEngine; using UnityEngine.UIElements;public class ContextMenuWindow : EditorWindow { [MenuItem("My/Context Menu Window")] static void ShowMe() => GetWindow...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cc3ddf82b05e
unity_docs
rendering
Show me a Unity C# example demonstrating `RaycastHit.barycentricCoordinate`.
RaycastHit.barycentricCoordinate public Vector3 barycentricCoordinate ; Description The barycentric coordinate of the triangle we hit. This lets you interpolate any of the vertex data along the 3 axes. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Attach this script to a camera and i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_84b22a95816f
unity_docs
editor
Give me an overview of the `Debug` class in Unity.
Debug class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Class containing methods to ease debugging while developing a game. Static Properties Property Description developerConsoleEnabled Allows you to enable or disable the developer console. developerConsoleVisible Controls whether ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9ba176e7797
unity_docs
physics
What is `BuildOptions` in Unity? Explain its purpose and usage.
BuildOptions enumeration Description Options to configure a build. You can combine multiple build options together. Additional resources: BuildPipeline.BuildPlayer . Properties Property Description None Perform the specified build without any special settings or extra tasks. Development Build a development v...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_637948bf3e30
unity_docs
scripting
Show me a Unity C# example demonstrating `Behaviour.isActiveAndEnabled`.
ed ( Behaviour.enabled == true ). The component's MonoBehaviour.OnEnable method has been called. Important: Even if a component is enabled and its GameObject is active, isActiveAndEnabled still returns false until OnEnable is called on the component. This is by design in Unity's scripting lifecyle. For mor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_517ed7e1d2e9
unity_docs
scripting
What are the parameters of `SceneManagement.SceneManager.sceneLoaded` in Unity?
Description Assign a custom callback to this event to get notifications when a Scene has loaded. Create a custom callback method to receive the notification and assign it to the SceneManager.sceneLoaded event. The callback must have the required signature, taking a Scene and a LoadSceneMode as input parameters. The cod...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_93a8ac490203
unity_docs
rendering
In Unity's 'Control occlusion in areas with Occlusion Portals', what is 'Occlusion Portal component reference' and how does it work?
Property: Function: Open If enabled, the Occlusion Portal is open, and does not occlude Renderers. If disabled, the Occlusion Portal is closed, and occludes Renderers. Center Set the center of the Occlusion Portal. The default value is 0,0,0. Size Define the size of the Occlusion Portal.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_23d7b37aa1bd
unity_docs
performance
In Unity's 'Video Profiler module reference', what is 'Module details pane' and how does it work?
When you select a frame in the Video Profiler module, the module details pane displays further detailed information on the video playback in your scene. The following information is available: Detail Description Total Video Sources The number of video sources in your scene. Playing Video Sources The number of video sou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9255a0608f73
unity_docs
scripting
What is `Playables.PlayableGraph.Evaluate` in Unity? Explain its purpose and usage.
PlayableGraph.Evaluate Declaration public void Evaluate (float deltaTime = 0); Declaration public void Evaluate (); Parameters Parameter Description deltaTime The time in seconds by which to advance each Playable in the graph. Description Evaluates all the PlayableOutput s in the graph, and updates...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e3a9c14befc2
unity_docs
editor
Show me a Unity code example for 'Simulated classes'.
Engine.Screen.brightness , which always returns 1 . For information on which members the Device Simulator simulates, see the API documentation for: Device.Application Device.Screen Device.SystemInfo ## Updating your scripts to use simulated classes If you want to convert existing code to use classes from the UnityEng...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57e6a5f18701
unity_docs
scripting
What is `Rendering.IndexFormat` in Unity? Explain its purpose and usage.
IndexFormat enumeration Description Format of the mesh index buffer data. Index buffer can either be 16 bit (supports up to 65535 vertices in a mesh), or 32 bit (supports up to 4 billion vertices). Default index format is 16 bit, since that takes less memory and bandwidth. Note that GPU support for 32 bit indices ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5afe2d038723
unity_docs
xr
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetrics.GetSummaryOfMetrics` in Unity? Explain its purpose and usage.
AsyncReadManagerMetrics.GetSummaryOfMetrics Declaration public static Unity.IO.LowLevel.Unsafe.AsyncReadManagerSummaryMetrics GetSummaryOfMetrics (AsyncReadManagerRequestMetric[] metrics ); Declaration public static Unity.IO.LowLevel.Unsafe.AsyncReadManagerSummaryMetrics GetSummaryOfMetrics (List<AsyncReadM...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ea80d55f1f76
unity_docs
physics
What is `ParticleSystemForceField.vectorFieldSpeed` in Unity? Explain its purpose and usage.
ParticleSystemForceField.vectorFieldSpeed public ParticleSystem.MinMaxCurve vectorFieldSpeed ; Description The speed at which particles are propelled through the vector field. Set in conjunction with ParticleSystemForceField.vectorFieldAttraction to apply a vector field to the particle motion. Additional r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f92fe6f677d9
unity_docs
rendering
Explain 'Rotation over Lifetime module reference' in Unity.
Here, you can configure particles to rotate as they move. ## Properties For some properties in this section, you can use different modes to set their value. For information on the modes you can use, refer to Vary Particle System properties over time . Property Function Separate Axes Allow rotation to be specified per...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2935df093cae
unity_docs
scripting
What are the parameters of `Video.VideoPlayer.EventHandler` in Unity?
Description Delegate type for all events without parameters emitted by VideoPlayer s. Use this EventHandler to define what you want to happen when the VideoPlayer emits certain events. This EventHandler accepts the following VideoPlayer events: VideoPlayer.loopPointReached VideoPlayer.started VideoPlayer.prepareComplet...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5ee3fed68957
unity_docs
rendering
Explain 'Light Probe Proxy Volume component reference for the Built-In Render Pipeline' in Unity.
There are three options available: Bounding Box Mode: Function: Automatic Local (default value) A local-space bounding box is computed. The interpolated Light Probe positions are generated inside this bounding box. If a Renderer component isn’t attached to the GameObject , then a default bounding box is generated. The ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a11fb52d073d
unity_docs
scripting
What is `Windows.WebCam.VideoCapture.VideoCaptureResult.resultType` in Unity? Explain its purpose and usage.
VideoCapture.VideoCaptureResult.resultType public Windows.WebCam.VideoCapture.CaptureResultType resultType ; Description A generic result that indicates whether or not the VideoCapture operation succeeded.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5d1c4b57ae08
unity_docs
rendering
Show me a Unity C# example demonstrating `SceneViewCameraWindow.additionalSettingsGui`.
SceneViewCameraWindow.additionalSettingsGui Parameters Parameter Description value The SceneView that opened the SceneViewCameraWindow window. Description Subscribe to this event to receive a callback when the SceneViewCameraWindow.OnGUI function is called. ```csharp using UnityEditor; using UnityEngine;...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d60a96ba2a09
unity_docs
scripting
Show me a Unity C# example demonstrating `Video.VideoClip.pixelAspectRatioNumerator`.
tor:denominator). (Read Only). The pixel aspect ratio (for example, 10:11) determines the shape of each pixel. The first number (10) is the numerator and is the width of the pixel. The second number (11) is the denominator and is the height of the pixel. You can use the pixel aspect ratio to resize a video to appear l...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_240050de4bef
unity_docs
performance
What is `Jobs.IJobParallelForTransformExtensions.ScheduleReadOnly` in Unity? Explain its purpose and usage.
IJobParallelForTransformExtensions.ScheduleReadOnly Declaration public static Unity.Jobs.JobHandle ScheduleReadOnly (T jobData , Jobs.TransformAccessArray transforms , int batchSize , Unity.Jobs.JobHandle dependsOn ); Parameters Parameter Description jobData The job to schedule. transforms The Tr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e81049a1d114
unity_docs
physics
What is `Cloth.externalAcceleration` in Unity? Explain its purpose and usage.
Cloth.externalAcceleration public Vector3 externalAcceleration ; Description A constant, external acceleration applied to the cloth. Use this to simulate constant forces on the cloth, such as wind waving a flag. Additional resources: Cloth.randomAcceleration . ```csharp using UnityEngine;public class Examp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4da89d998b2f
unity_docs
audio
What is `VideoClipImporter.importAudio` in Unity? Explain its purpose and usage.
VideoClipImporter.importAudio public bool importAudio ; Description Import audio tracks from source file. Setting this to true causes the VideoClipImporter to import audio tracks embedded in video source files. Setting it to false causes audio not to be imported.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_debefb66d1a9
unity_docs
xr
Show me a Unity code example for 'Set up an XR scene'.
truction meshes, and image tracking. Refer to Fully Immersive VR on visionOS . ## Detect whether XR is enabled If you have a scene that can be used in both XR and non-XR contexts, you can use the XRSettings.enabled property to detect whether the XR subsystems are currently loaded and active. With that information you...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_103347a59c12_doc_10
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Stores the used to display the current turn speed of continuous turning. Signature: ```csharp public Text turnSpeedValueText ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_647de3a699b2
unity_docs
scripting
Show me a Unity C# example demonstrating `GUI.PasswordField`.
ed back to the string as shown in the example. maskChar Character to mask the password with. maxLength The maximum length of the string. If left out, the user can type for ever and ever. style The style to use. If left out, the textField style from the current GUISkin is used. Returns string The edited pa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_36eb6a53bdb2
unity_docs
editor
What is `Experimental.GraphView.EdgeDragHelper` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeDragHelper class in UnityEditor.Experimental.GraphView Description EdgeDragHelper's constructor. Properties Property Description draggedPort The port the edge is being dragged from. edgeCandidate The edge being dragged...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9c8122005f65
unity_docs
scripting
What are the parameters of `EditorGUILayout.CurveField` in Unity?
Returns AnimationCurve The curve edited by the user. Description Make a field for editing an AnimationCurve . Create an animation on the different axis and assign it to a GameObject. ```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEditor;public class FollowCurve : Edi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_be46fe65d6b4
unity_docs
rendering
Show me a Unity code example for 'Example of changing per-instance data at runtime in the Built-In Render Pipeline'.
The following example demonstrates how to use MaterialPropertyBlock objects to set per-instance data for a group of GameObjects at runtime. It sets the _Color property from the above shader examples to a random color. Important : MaterialPropertyBlocks break SRP Batcher compatibility. For more information, see GPU inst...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_feff0dfc9b01
unity_docs
rendering
In Unity's 'Asset import determinism', what is 'Keeping import history' and how does it work?
Use the Import Activity window to inspect re-import reasons and timestamps. You can disable automatic artifact cleanup when analyzing imports as follows: ``` EditorUserSettings.artifactGarbageCollection = false ``` This prevents Unity from deleting previous import artifacts. Deleting the Library folder clears all histo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.