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_e4de6d4a3122
unity_docs
input
What is `GameObject.SetGameObjectsActive` in Unity? Explain its purpose and usage.
GameObject.SetGameObjectsActive Declaration public static void SetGameObjectsActive (NativeArray<int> instanceIDs , bool active ); Declaration public static void SetGameObjectsActive (ReadOnlySpan<int> instanceIDs , bool active ); Parameters Parameter Description instanceIDs Instance IDs of GameObjec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2100d19f182
unity_docs
scripting
What is `ParticleSystem.CollisionModule.bounce` in Unity? Explain its purpose and usage.
ParticleSystem.CollisionModule.bounce public ParticleSystem.MinMaxCurve bounce ; Description How much force is applied to each particle after a collision. Additional resources: ParticleSystem.collision , MinMaxCurve . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleS...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_158117440660
unity_docs
math
What is `AndroidJNI.CallStaticLongMethodUnsafe` in Unity? Explain its purpose and usage.
AndroidJNI.CallStaticLongMethodUnsafe Declaration public static long CallStaticLongMethodUnsafe (IntPtr clazz , IntPtr methodID , jvalue* args ); Description Invokes the specified methodID static method on a Java object, optionally passing in an array of arguments ( args ). Additional resources: Java Nati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a788c415fada
unity_docs
editor
What are the parameters of `VersionControl.Provider.GetLatest` in Unity?
Description Start a task for getting the latest version of an out of sync asset from the version control server. Note that the Provider.GetLatest task does not solve file conflicts, in such cases consider using the Provider.Resolve method as well. ```csharp using System.Collections.Generic; using UnityEditor; using Uni...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_44079e3a507b
unity_docs
physics
What is `Collision2D.GetContacts` in Unity? Explain its purpose and usage.
Collision2D.GetContacts Declaration public int GetContacts (ContactPoint2D[] contacts ); Parameters Parameter Description contacts An array of ContactPoint2D used to receive the results. Returns int Returns the number of contacts placed in the contacts array. Description Retrieves all contact poi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c0fdbf09210
unity_docs
editor
What is `SceneManagement.PrefabStage.openedFromInstanceObject` in Unity? Explain its purpose and usage.
PrefabStage.openedFromInstanceObject public GameObject openedFromInstanceObject ; Description A GameObject inside the Prefab instance that you opened Prefab Mode through. If, to open Prefab Mode, you clicked the angled right arrow next to a Prefab instance root, this GameObject is that root. If you opened Pre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d45d999a2f31
unity_docs
scripting
What is `LODGroup` in Unity? Explain its purpose and usage.
LODGroup class in UnityEngine / Inherits from: Component / Implemented in: UnityEngine.CoreModule Description LODGroup lets you group multiple Renderers into LOD levels. This can be used to switch between different LOD levels at runtime based on size on screen. Static Properties Property Description cros...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_70a47406c7a4
unity_docs
editor
What is `TerrainTools.TerrainPaintTool_1.OnInspectorGUI` in Unity? Explain its purpose and usage.
TerrainPaintTool<T0>.OnInspectorGUI Declaration public void OnInspectorGUI ( Terrain terrain , TerrainTools.IOnInspectorGUI editContext ); Parameters Parameter Description terrain Active Terrain object. editContext Interface used to communicate between Editor and Paint tools. Description Custom terra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_36bbcaa9aa1c
unity_docs
physics
Show me a Unity code example for 'Build for Embedded Linux from the command line'.
build host can be a Linux, Windows, or macOS machine. The following example uses the Linux variant of the executable ( Unity ), but you can replace it with an equivalent executable for your preferred build host’s operating system. ## Command line arguments To instruct Unity to start in CLI mode and build the project ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f6d0950a152
unity_docs
scripting
What is `Unity.IntegerTime.RationalTimeExtensions.Divide` in Unity? Explain its purpose and usage.
RationalTimeExtensions.Divide Declaration public static Unity.IntegerTime.RationalTime Divide ( Unity.IntegerTime.RationalTime lhs , Unity.IntegerTime.RationalTime rhs ); Parameters Parameter Description t The left hand side. r The right hand side. Returns RationalTime A new instance that is the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_83a04ec9dd6c
unity_docs
input
In Unity's 'Input for Android devices', what is 'Android keyboard' and how does it work?
Android devices include a touchscreen keyboard. When you select editable UI elements such as Input Fields Unity automatically activates the Android touchscreen keyboard and handles input from it. For information on how to manually activate and configure the Android touchscreen keyboard, refer to Mobile Keyboard .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7cae2c7bf7e5
unity_docs
rendering
In Unity's 'Reflective Parallax Specular', what is 'Parallax Normal mapped Properties' and how does it work?
Parallax Normal mapped is the same as regular Normal mapped , but with a better simulation of “depth”. The extra depth effect is achieved through the use of a Height Map . The Height Map is contained in the alpha channel of the Normal map . In the alpha, black is zero depth and white is full depth. This is most often u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ac753ed49217
unity_docs
physics
Explain 'Use a scoped registry in your project' in Unity.
Add a scoped registry to your project to access custom packages. ## Integrity and security of scoped registries Whenever you add a scoped registry to your project, use the same level of caution that you use when installing any other third-party software: Install scoped registries only from trusted sources, because th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0d6eab1a6b79
unity_docs
scripting
What is `Windows.Speech.PhraseRecognizer` in Unity? Explain its purpose and usage.
PhraseRecognizer class in UnityEngine.Windows.Speech / Implemented in: UnityEngine.CoreModule Description A common base class for both keyword recognizer and grammar recognizer. Phrase recognizer is the smallest speech recognition unit that can be individually started and stopped. Typically, you should create a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_428103fc969b
github
scripting
Write a Unity C# MonoBehaviour script called View Normals
```csharp using UnityEngine; [ExecuteInEditMode] public class ViewNormals : MonoBehaviour { // Use this for initialization private MeshFilter objectMesh; void OnDrawGizmos() { if (objectMesh != null) { for (int i = 0; i < objectMesh.mesh.vertexCount; ++i) ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_ca4376ed4d9b
unity_docs
editor
Show me a Unity C# example demonstrating `IMGUI.Controls.PrimitiveBoundsHandle.DrawHandle`.
display this instance in the current handle camera using its current configuration. Always write properties to the handle before calling this function. Place the calls to this function inside EditorGUI.BeginChangeCheck and EditorGUI.EndChangeCheck to detect user interaction and read the updated properties from the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_38a1071e82e8_doc_7
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The size, in viewport units, of the periphery inside the viewport that will not be considered in view. Signature: ```csharp public float viewportPeriphery ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_4d7a0613804c
unity_docs
physics
What is `Search.SearchService.ShowObjectPicker` in Unity? Explain its purpose and usage.
SearchService.ShowObjectPicker Declaration public static Search.ISearchView ShowObjectPicker (Action<Object,bool> selectHandler , Action<Object> trackingHandler , string searchText , string typeName , Type filterType , float defaultWidth , float defaultHeight , Search.SearchFlags flags ); Parameters ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c3184c713be
unity_docs
scripting
What is `Mesh.bounds` in Unity? Explain its purpose and usage.
Mesh.bounds public Bounds bounds ; Description The bounding volume of the Mesh. This is the axis-aligned bounding box of the mesh in its own space, so the bounds don't change if you change the Transform position, rotation or scale. The Renderer.bounds property is similar but returns the bounds in world spa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6b8514372431
unity_docs
rendering
What is `Lightmapping.lightingSettings` in Unity? Explain its purpose and usage.
Lightmapping.lightingSettings public static LightingSettings lightingSettings ; Description The LightingSettings that will be used for the current Scene. Will throw an exception if it is null. Additional resources: TryGetLightingSettings .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f1c048b6d69a
unity_docs
scripting
Show me a Unity C# example demonstrating `Transform.Find`.
me n and returns it. If no child with name n can be found, null is returned. If n contains a '/' character it will access the Transform in the hierarchy like a path name. Note: Find does not work properly if you have '/' in the name of a GameObject. Note: Find does not perform a recursive descend down a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_911889dd0f0e
unity_docs
math
What is `PlayerSettings.SetAdditionalCompilerArguments` in Unity? Explain its purpose and usage.
PlayerSettings.SetAdditionalCompilerArguments Declaration public static void SetAdditionalCompilerArguments ( Build.NamedBuildTarget buildTarget , string[] additionalCompilerArguments ); Parameters Parameter Description buildTarget The NamedBuildTarget . additionalCompilerArguments An array of the addi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fef6ae5bc226
unity_docs
rendering
What are the parameters of `Graphics.RenderMeshInstanced` in Unity?
Description Renders multiple instances of a mesh using GPU instancing. This function renders Meshes for the current frame, similar to Graphics.RenderMesh , but is more performant due to the use of GPU instancing. Use this function to render the same Mesh multiple times using an instanced shader. Unity automatically cal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2e255cfe2bbe
unity_docs
input
Show me a Unity C# example demonstrating `GUIUtility.hotControl`.
ontrol ; Description The controlID of the current hot control. The hot control is one that is temporarily active. When the user mousedown's on a button, it becomes hot. No other controls are allowed to respond to mouse events while some other control is hot. once the user mouseup's, the control sets hotControl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_00a3e91ef49f
unity_docs
rendering
Explain 'Highlights Profiler module reference' in Unity.
The Highlights Profiler module displays information on whether your application is meeting its target frame rate and if its performance is bound by the CPU or the GPU. It can help you to determine if your application is CPU bound or GPU bound and where to begin investigating potential performance problems. This module ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_587bc034b3ef
unity_docs
physics
Explain 'Moving objects with vectors' in Unity.
Vectors are a fundamental mathematical concept which allow you to describe a direction and magnitude. In games and apps, vectors are often used to describe fundamental properties such as the position of a character, the speed something is moving, or the distance between two objects. Vector arithmetic is fundamental to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ecb7726fb2fb
unity_docs
math
What is `UIElements.Clickable.ProcessUpEvent` in Unity? Explain its purpose and usage.
Clickable.ProcessUpEvent Declaration protected void ProcessUpEvent ( UIElements.EventBase evt , Vector2 localPosition , int pointerId ); Description This method processes the up event sent to the target Element.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b5615b28e8f5
unity_docs
scripting
Show me a Unity C# example demonstrating `Component.GetComponentInChildren`.
d to that GameObject). You can then call GetComponentInChildren on that reference. See the Component and GameObject class reference pages for the other variations of the GetComponent family of methods. The following example gets a reference to a hinge joint component on the same GameObject as the script, or any...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f41db8e2afc
unity_docs
audio
Show me a Unity C# example demonstrating `Rendering.SplashScreen.isFinished`.
SplashScreen.isFinished public static bool isFinished ; Description Returns true once the splash screen has finished. This is once all logos have been shown for their specified duration. ```csharp using System.Collections; using UnityEngine; using UnityEngine.Rendering;// This example shows how you could draw t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f08644d9197a
unity_docs
scripting
What is `Rendering.SupportedRenderingFeatures.reflectionProbesBlendDistance` in Unity? Explain its purpose and usage.
SupportedRenderingFeatures.reflectionProbesBlendDistance public bool reflectionProbesBlendDistance ; Description If this property is true, the blend distance field in the Reflection Probe Inspector window is editable. Additional resources: ReflectionProbe.blendDistance .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_beaad7bb8ec1
unity_docs
scripting
What is `Sprites.PackerJob.AssignToAtlas` in Unity? Explain its purpose and usage.
PackerJob.AssignToAtlas Declaration public void AssignToAtlas (string atlasName , Sprite sprite , SpritePackingMode packingMode , SpritePackingRotation packingRotation ); Description Assigns a Sprite to an already registered atlas.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ec4245edb6b
unity_docs
scripting
What is `Video.VideoPlayer.isPrepared` in Unity? Explain its purpose and usage.
VideoPlayer.isPrepared public bool isPrepared ; Description Returns whether the VideoPlayer has successfully prepared the content to be played. A prepared VideoPlayer can play back the content instantly because preliminary parsing and buffering has been done. A VideoPlayer starts out as not prepared ( false ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eb2de59c60e1
unity_docs
scripting
Show me a Unity C# example demonstrating `SystemLanguage.Slovak`.
SystemLanguage.Slovak Description Slovak. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { //This checks if your computer's operating system is in the Slovak language if (Application.systemLanguage == SystemLanguage.Slovak) { //Outputs into console that the system is Slovak D...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1ad72fcf5e5b_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Links one event from broadcaster GameObject to one method from listener GameObject's MoonoBehaviour. Signature: ```csharp public class EventLink<T1, T2> : EventLinkBase ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_9ae754182e39
unity_docs
math
What is `Collider.ClosestPointOnBounds` in Unity? Explain its purpose and usage.
Collider.ClosestPointOnBounds Declaration public Vector3 ClosestPointOnBounds ( Vector3 position ); Description The closest point to the bounding box of the attached collider. This can be used to calculate hit points when applying explosion damage. ```csharp using UnityEngine; using System.Collections;publ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_427463d9798e
unity_docs
scripting
What is `PackageManager.UI.IPackageManagerExtension.OnPackageSelectionChange` in Unity? Explain its purpose and usage.
IPackageManagerExtension.OnPackageSelectionChange Declaration public void OnPackageSelectionChange (PackageInfo packageInfo ); Parameters Parameter Description packageInfo The newly selected package information (can be null). Description Called by the Package Manager UI when the package selection changed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4be1a4e2c0cc
unity_docs
rendering
In Unity's 'Pass tags in ShaderLab reference', what is 'Render pipeline compatibility' and how does it work?
Feature name Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Custom SRP Built-in Render Pipeline ShaderLab: Pass Tags block Yes Yes Yes Yes ShaderLab: LightMode Pass tag Yes Yes Yes Yes
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7b3e345d29f6
unity_docs
rendering
Explain 'Introduction to shaders' in Unity.
A shader program, commonly referred to as a shader, is a program that runs on a GPU. ## Types of shader In Unity, shaders are divided into three broad categories. You use each category for different things, and work with them differently. Shaders that are part of the graphics pipeline are the most common type of shad...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f2410ca80d43
unity_docs
rendering
What is `UIElements.RuntimePanelUtils.CameraTransformWorldToPanel` in Unity? Explain its purpose and usage.
RuntimePanelUtils.CameraTransformWorldToPanel Declaration public static Vector2 CameraTransformWorldToPanel ( UIElements.IPanel panel , Vector3 worldPosition , Camera camera ); Parameters Parameter Description panel The local coordinates reference panel. worldPosition The world position to transfo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5728dcdceee3
unity_docs
physics
In Unity's 'Create a custom build script', what is 'Create an advanced build script with build profiles and AssetBundles' and how does it work?
This example demonstrates a custom build script that introduces several advanced concepts: Using the active build profile : This script automatically sets the scene list, flags, and settings based on the active build profile . Before using this script, you configure the builds by creating and saving build profiles in t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_22f169d753ba
unity_docs
scripting
What is `UIElements.UxmlAttributeDescription.TryGetValueFromBag` in Unity? Explain its purpose and usage.
UxmlAttributeDescription.TryGetValueFromBag Declaration protected bool TryGetValueFromBag ( UIElements.IUxmlAttributes bag , UIElements.CreationContext cc , Func<string,T,T> converterFunc , T defaultValue , ref T value ); Parameters Parameter Description bag A bag contains attributes and their values ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0e9be7d57841
unity_docs
ui
Show me a Unity C# example demonstrating `UIElements.UxmlElementAttribute`.
brary tab in UI Builder. The visibility field can be used to control the visibility of the custom control in the Library tab. For an example of migrating a custom control from UxmlFactory and UxmlTraits to the UxmlElement and UxmlAttributes system, refer to Enhanced custom controls creation with UXML . ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d8f7497c6a2a
unity_docs
physics
Explain 'Reference other files from UXML' in Unity.
In a UXML file, you can use the <Template> and the <Style> elements to reference other UXML or USS files. The two elements both accept either an src attribute or a path attribute. ## Thesrcattribute This is the recommended way to reference other files. Use the following syntax for the src attribute: ``` src="<path-to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4dd5278d5139
unity_docs
xr
In Unity's 'Apple ARKit XR Plugin', 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.xr.arkit@6.5 released 6.5.0-pre.1, 6.5.0-pre.2, 6.5.0-pre.3, 6.5.0 com.unity.xr.arkit@6.4 released 6.4.0-pre.1, 6.4.0, 6.4.1, 6.4.2 com.unity.xr.arkit@6.3 released 6.3.0-pre.1, 6.3.0-pre.2, 6.3.0, 6...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_427896aa884e
unity_docs
math
What are the parameters of `Tilemaps.Tilemap.GetTilesBlock` in Unity?
Returns TileBase[] The array of Tile s at the given bounds. Description Retrieves an array of Tiles with the given bounds. This is meant for more a performant way to get Tiles as a batch, when compared to calling GetTile for every single position. The bounds size must match the array size. For example bounds of 1x2x3 n...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_423a68ddc583
unity_docs
scripting
What is `Logger.LogException` in Unity? Explain its purpose and usage.
Logger.LogException Declaration public void LogException (Exception exception ); Declaration public void LogException (Exception exception , Object context ); Parameters Parameter Description exception Runtime Exception. context Object to which the message applies. Description A variant of Logge...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ecb6af3d884b
unity_docs
rendering
What is `ParticleSystemRenderer.maskInteraction` in Unity? Explain its purpose and usage.
ParticleSystemRenderer.maskInteraction public SpriteMaskInteraction maskInteraction ; Description Specifies how the Particle System Renderer interacts with SpriteMask . By default, particles do not interact with SpriteMasks and are visible regardless of whether you assign a SpriteMask or not. You can make th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0f39b03a263c
unity_docs
audio
Show me a Unity C# example demonstrating `Rendering.SplashScreen.Begin`.
SplashScreen.Begin Declaration public static void Begin (); Description Initializes the splash screen so it is ready to begin drawing. Call this before you start calling SplashScreen.Draw . Internally this function resets the timer and prepares the logos for drawing. ```csharp using System.Collections; using U...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c75febd9530
unity_docs
scripting
What is `PlayerLoop.Initialization` in Unity? Explain its purpose and usage.
Initialization struct in UnityEngine.PlayerLoop / Implemented in: UnityEngine.CoreModule Description Update phase in the native player loop. This is the C# representation of an update phase in the native player loop. It can only be used to identify the update phase in native.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d1326fd7fa5a
unity_docs
scripting
What is `Build.Content.ProfileEventType` in Unity? Explain its purpose and usage.
ProfileEventType enumeration Description Options for labelling captured profile events using the ContentBuildInterface.BeginProfileCapture and ContentBuildInterface.EndProfileCapture APIs. Properties Property Description Begin Use to indicate that a task has begun. End Use to indicate that a task has ended. I...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6a0ac8149e21
unity_docs
editor
What are the parameters of `VersionControl.Provider.SubmitIsValid` in Unity?
Description Returns true if submitting the assets is a valid operation. Do note that the task will always return true if the changeset parameter is set to an existing changeset. ```csharp using System.Collections.Generic; using UnityEditor; using UnityEditor.VersionControl; using UnityEngine;public class EditorScript :...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f98b22a1475b
unity_docs
input
What is `UIElements.Hash128Field` in Unity? Explain its purpose and usage.
Hash128Field class in UnityEngine.UIElements / Inherits from: UIElements.TextInputBaseField_1 / Implemented in: UnityEngine.UIElementsModule Description Makes a field for editing an Hash128 . For more information, refer to UXML element Hash128Field . Static Properties Property Description inputUssClas...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2d982123f63c
unity_docs
scripting
What is `Experimental.GraphView.GraphView.elementsInsertedToStackNode` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphView.elementsInsertedToStackNode public Action<StackNode,int,IEnumerable<GraphElement>> elementsInsertedToStackNode ; Description Callback for when GraphElements are inserted into a StackNode.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0e5360fd2dac
unity_docs
physics
What is `SpringJoint.tolerance` in Unity? Explain its purpose and usage.
SpringJoint.tolerance public float tolerance ; Description The maximum allowed error between the current spring length and the length defined by minDistance and maxDistance . If the tolerance is set very high the solver might not run and the spring would effectively not exist. If the tolerance is set close ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_170992589b32
unity_docs
rendering
What is `Experimental.Rendering.GraphicsFormatUtility.GetFormatString` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormatUtility.GetFormatString Declaration public static string GetFormatString ( Experimental.Rendering.GraphicsFormat format ); Declaration public static string GetFormatString ( TextureFormat format ); Descri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e610183cb37
unity_docs
rendering
What is `AssetPostprocessor.OnPreprocessMaterialDescription` in Unity? Explain its purpose and usage.
AssetPostprocessor.OnPreprocessMaterialDescription(MaterialDescription,Material, AnimationClip[]) Parameters Parameter Description description A MaterialDescription that describes the imported camera properties and animations. material The material generated by the Model Importer. animations The animation c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_012769f04f80
unity_docs
editor
What is `Search.SearchFlags` in Unity? Explain its purpose and usage.
SearchFlags enumeration Description Search options used to fetch items. Mostly with SearchContext to specify how a search should be handled. ```csharp using System.Collections; using System.Collections.Generic; using UnityEditor; using UnityEditor.Search; using UnityEngine; public class SearchFlags_NoIndexing {...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9393359adae6
unity_docs
editor
What is `IMGUI.Controls.TreeView.RenameEndedArgs` in Unity? Explain its purpose and usage.
RenameEndedArgs struct in UnityEditor.IMGUI.Controls Description Method arguments for the virtual method RenameEnded . Properties Property Description acceptedRename Is true if the rename is accepted. itemID Item with ID that are being renamed. newName Name entered in the rename overlay. originalName The o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_63ef258a83b9
unity_docs
scripting
What is `Experimental.GraphView.Port` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Port class in UnityEditor.Experimental.GraphView / Inherits from: Experimental.GraphView.GraphElement Description GraphView Port class. Properties Property Description allowMultiDrag When this property is set to true, you...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5d0b4d5e3145
unity_docs
scripting
In Unity's 'Introduction to asynchronous programming with Awaitable', what is 'Awaitable compared to .NET ValueTask' and how does it work?
The .NET ValueTask<TResult> offers some of the same key benefits and limitations of Awaitable . The typical recommended use for ValueTask is for asynchronous workloads that are expected to complete synchronously most of the time. For more information, refer to Understanding the Whys, Whats, and Whens of ValueTask .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_35f8fb3212ea_doc_10
github
scripting
What does `OnDrag` do in this Unity script? Explain its purpose and signature.
Handle ongoing drag: forward to ScrollRect and optionally cancel button press if dragged too far. Signature: ```csharp public void OnDrag(PointerEventData eventData) ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_9669a477b3a7
unity_docs
ui
Explain 'Bind to a list with ListView' in Unity.
Version : 2021.3+ The ListView control is the most efficient way to create lists. To bind to a list with ListView, set the binding path of the ListView to the name of the property that contains the list. This example demonstrates how to bind to a list with ListView. ## Example overview The example creates a list of t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a0c3987f9232
unity_docs
rendering
Give me an overview of the `ModelImporterMaterialImportMode` class in Unity.
ModelImporterMaterialImportMode enumeration Description Material import options for ModelImporter . Determines the method used to handle materials in the Model Importer. Properties Property Description None The model importer does not import materials. ImportStandard The model importer imports materials in s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c246364e7a98_doc_0
github
scripting
What does `MapTo01` do in this Unity script? Explain its purpose and signature.
Converts a float to its 0-1 position in the given range. Signature: ```csharp public static float MapTo01(this float x, float xMin, float xMax) => Mathf.Clamp01(MapTo(x, xMin, xMax)); ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_1d9de2aa7e91
unity_docs
editor
What is `PluginImporter.GetIcon` in Unity? Explain its purpose and usage.
PluginImporter.GetIcon Declaration public Texture2D GetIcon (string className ); Parameters Parameter Description className The fully qualified class name of a MonoScript imported by this plugin. Returns Texture2D Returns the custom icon that will be associated with the imported MonoScript . If no c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c5262245ba7f
unity_docs
scripting
What is `UIElements.Foldout.value` in Unity? Explain its purpose and usage.
Foldout.value public bool value ; Description This is the state of the Foldout's toggle. It is true if the Foldout is open and its contents are visible, and false if the Foldout is closed, and its contents are hidden.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3549715b3153
unity_docs
rendering
In Unity's 'Upgrade to Unity 6.0', what is 'Improvements to light probe energy conservation' and how does it work?
Light Probes are now as bright as lightmaps . Previously, Unity’s Light Probes were only 94% as bright as they should be. For this reason, objects lit with light probes appeared a bit darker than objects lit with lightmaps. Because of the subtlety of this change, it is possible that many users won’t see a noticeable di...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d9bf486a65ea
unity_docs
scripting
Show me a Unity C# example demonstrating `Animations.TransformSceneHandle`.
TransformSceneHandle struct in UnityEngine.Animations / Implemented in: UnityEngine.AnimationModule Description Handle to read position, rotation and scale of an object in the Scene. TransformSceneHandle are read-only. A TransformSceneHandle is a safe handle on a TransformAccess . The Animator used to create...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e2d65e3bca3e
unity_docs
rendering
What is `LightingSettings.Lightmapper` in Unity? Explain its purpose and usage.
Lightmapper enumeration Description Backends available for baking lighting. Properties Property Description ProgressiveCPU Backend for baking lighting using the CPU. Uses a progressive path tracing algorithm. ProgressiveGPU Backend for baking lighting using the GPU. Uses a progressive path tracing algorithm.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49615f744b85
unity_docs
scripting
What is `Color.grey` in Unity? Explain its purpose and usage.
Color.grey public static Color grey ; Description English spelling for gray . RGBA is the same (0.5, 0.5, 0.5, 1). ```csharp //Attach this script to a GameObject with a Renderer (go to Create>3D Object and select one of the first 6 options to create a GameObject with a Renderer automatically attached). //Thi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb07417ba595
unity_docs
scripting
What is `SubsystemsImplementation.SubsystemWithProvider.running` in Unity? Explain its purpose and usage.
SubsystemWithProvider.running public bool running ; Description Whether or not the subsystem is running. This returns true after Start has been called on the subsystem, and false after Stop is called.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e2e8fe02749
unity_docs
rendering
What is `RenderTextureDescriptor.ctor` in Unity? Explain its purpose and usage.
RenderTextureDescriptor.RenderTextureDescriptor Constructor Declaration public RenderTextureDescriptor (int width , int height , RenderTextureFormat colorFormat = RenderTextureFormat.Default, int depthBufferBits = 0, int mipCount = Texture.GenerateAllMips, RenderTextureReadWrite readWrite = RenderTextu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_489d012738bf
unity_docs
scripting
What is `Device.Application.GetStackTraceLogType` in Unity? Explain its purpose and usage.
Application.GetStackTraceLogType Declaration public static StackTraceLogType GetStackTraceLogType ( LogType logType ); Description This has the same functionality as Application.GetStackTraceLogType . At the moment, the Device Simulator doesn't support simulation of this method.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7e9d661f28d1
unity_docs
editor
What is `CloudProjectSettings` in Unity? Explain its purpose and usage.
CloudProjectSettings class in UnityEditor Description Use this class to retrieve information about the currently selected project and the current Unity ID that is logged in. Static Properties Property Description coppaCompliance The current COPPA compliance state. organizationId The Organization ID, formatted...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de25c71380a3
unity_docs
editor
What is `EditorUtility.InstanceIDToObject` in Unity? Explain its purpose and usage.
EditorUtility.InstanceIDToObject Declaration public static Object InstanceIDToObject (int instanceID ); Description Translates an instance ID to a reference to an object. If the object is not loaded from disk, loads it from disk. Editor Window to enter the instance ID and print the name of the object. ```csh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_967a6307b5d9_doc_15
github
scripting
What does `GetOverrides` do in this Unity script? Explain its purpose and signature.
Gets Tiling Rule overrides for thisA list of Tiling Rule overrides to fillThe input overrides list is not valid Signature: ```csharp public void GetOverrides(List<KeyValuePair<RuleTile.TilingRule, RuleTile.TilingRule>> overrides) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4c4663791fe3
unity_docs
physics
In Unity's 'Introduction to physics articulations', what is 'Building an Articulation in Unity' and how does it work?
To build a physics articulation in Unity, you must add an Articulation Body component to each GameObject that the articulation consists of. Each Articulation Body component allows you to configure in one single place: The physical body properties of the corresponding GameObject. Basically, its mass and the way it respo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_b7fffa3bf14b
github
scripting
Write a Unity C# XR/VR script for Order Room Binder
```csharp using UnityEngine; using System.Collections.Generic; namespace TapLive.Orders { /// <summary> /// Binds order data to XR room/UI elements /// Manages visual representation of orders in 3D space /// </summary> public class OrderRoomBinder : MonoBehaviour { [Header("Prefabs")] ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_3ec0fa8750ea
unity_docs
editor
What is `VersionControl.Provider.Move` in Unity? Explain its purpose and usage.
Provider.Move Declaration public static VersionControl.Task Move (string from , string to ); Parameters Parameter Description from Path to the source asset. to Path to the destination. Description Uses the version control plugin to move an asset from one path to another. Do note that the source asset...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_35d9b232b946
unity_docs
rendering
Explain 'Surface Shader required directives reference for the Built-In Render Pipeline' in Unity.
surfaceFunction - which Cg function has surface shader code. The function should have the form of void surf (Input IN, inout SurfaceOutput o) , where Input is a structure you have defined. Input should contain any texture coordinates and extra automatic variables needed by surface function. lightModel - lighting model ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f1cf9fde4b13
unity_docs
scripting
Give me an overview of the `Awaitable` class in Unity.
Awaitable class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Custom Unity type that can be awaited and used as an async return type in the C# asynchronous programming model. Awaitable is usually a preferable alternative to .NET Task for asynchronous code in Unity. It's important, howev...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b924f8157f3a
unity_docs
scripting
What is `UIElements.BindablePropertyChangedEventArgs.ctor` in Unity? Explain its purpose and usage.
BindablePropertyChangedEventArgs Constructor Declaration public BindablePropertyChangedEventArgs (ref UIElements.BindingId propertyName ); Parameters Parameter Description propertyName The name of the property that has changed. Description Instantiates a new BindablePropertyChangedEventArgs .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f3038dff21aa
unity_docs
scripting
What is `Search.PropertyDatabaseRecordKey.operator_gt` in Unity? Explain its purpose and usage.
PropertyDatabaseRecordKey.operator > public static bool operator > ( Search.PropertyDatabaseRecordKey lhs , Search.PropertyDatabaseRecordKey rhs ); Parameters Parameter Description lhs A record key. rhs A record key. Description The greater than operator.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d9abc7dadb4f
unity_docs
scripting
What is `AndroidJavaClass` in Unity? Explain its purpose and usage.
AndroidJavaClass class in UnityEngine / Inherits from: AndroidJavaObject / Implemented in: UnityEngine.AndroidJNIModule Description AndroidJavaClass is the Unity representation of a generic instance of java.lang.Class. Note : this API can be used from custom thread, but requires that thread to be attached to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_95a2c6703bb6
unity_docs
rendering
What is `VideoClipImporter.sRGBClip` in Unity? Explain its purpose and usage.
VideoClipImporter.sRGBClip public bool sRGBClip ; Description Whether the imported clip contains sRGB color data. This setting is copied into the VideoClip.sRGB value of the resulting clip. Additional resources: Linear and Gamma rendering , TextureImporter.sRGBTexture and PlayerSettings.colorSpace .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de3203f98e41
unity_docs
scripting
What is `GlobalObjectId.GetGlobalObjectIdSlow` in Unity? Explain its purpose and usage.
GlobalObjectId.GetGlobalObjectIdSlow Declaration public static GlobalObjectId GetGlobalObjectIdSlow ( Object targetObject ); Parameters Parameter Description targetObject The object to obtain the unique identifier for. Returns GlobalObjectId The GlobalObjectId for the object. If the conversion is un...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_914b30c298fb
unity_docs
rendering
In Unity's 'Cameras', what is 'Additional resources and examples' and how does it work?
📚 Documentation : Camera Inspector windows reference for URP 📚 Documentation : Camera Inspector window reference for the Built-In Render Pipeline 📚 Documentation : Camera render order in URP 👥 Community : Camera section at Unity Discussions
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20c23d023c03
unity_docs
scripting
What is `Accessibility.AccessibilitySettings.fontScaleChanged` in Unity? Explain its purpose and usage.
AccessibilitySettings.fontScaleChanged Description Event that is invoked on the main thread when the user changes the font scale in the system settings. For all the supported platforms, refer to AccessibilitySettings .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8a5ac5b53c27
unity_docs
scripting
What is `MPE.ChannelClient.Shutdown` in Unity? Explain its purpose and usage.
ChannelClient.Shutdown Declaration public static void Shutdown (); Description Closes all ChannelClients in this instance of Unity. For more information about what happens when a ChannelClient is closed, see ChannelClient.Close .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_243db4b86a77
unity_docs
scripting
What is `FullScreenMovieScalingMode.AspectFill` in Unity? Explain its purpose and usage.
FullScreenMovieScalingMode.AspectFill Description Scale the movie until the movie fills the entire screen. Content at the edges of the larger of the two dimensions is clipped so that the other dimension fits the screen exactly. The aspect ratio of the movie is preserved.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_86c32f389296
unity_docs
ui
Explain 'Switch to another version of a UPM package' in Unity.
Use the information on this page to update UPM packages that you installed from the Unity Registry or a scoped registry , or from a local source . The information on this page also applies to packages you installed from the Asset Store , if they’re in the UPM format. If you want to install a specific version of a packa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e5a1d90739ed
unity_docs
rendering
Show me a Unity code example for 'Final color modifier Surface Shader example in the Built-In Render Pipeline'.
urface Shader compilation directive finalcolor:functionName is used for this, with a function that takes Input IN, SurfaceOutput o, inout fixed4 color parameters. Here’s a simple Shader that applies tint to the final color. This is different from just applying tint to the surface Albedo color: this tint will also affec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_157335150f30
unity_docs
scripting
What is `ParticleSystemSimulationSpace` in Unity? Explain its purpose and usage.
ParticleSystemSimulationSpace enumeration Description The space to simulate particles in. Properties Property Description Local Simulate particles in local space. World Simulate particles in world space. Custom Simulate particles relative to a custom transform component, defined by ParticleSystem.MainModule.c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5edd17a92cdb
unity_docs
scripting
What is `UIElements.PointerEventBase_1.currentTarget` in Unity? Explain its purpose and usage.
PointerEventBase<T0>.currentTarget public UIElements.IEventHandler currentTarget ; Description Gets the current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_35abded7372f
unity_docs
networking
What is `Unity.Android.Gradle.Manifest.Gravity` in Unity? Explain its purpose and usage.
Gravity enumeration Description Mirrors the Gravity enum. For more information about the attribute, see Android's documentation: Gravity attribute Properties Property Description AxisClip Mirrors android:gravity="axisClip". AxisPullAfter Mirrors android:gravity="axisPullAfter". AxisPullBefore Mirrors an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6b8cc7e984b2
unity_docs
rendering
What is `MaterialPropertyBlock.GetFloat` in Unity? Explain its purpose and usage.
MaterialPropertyBlock.GetFloat Declaration public float GetFloat (string name ); Declaration public float GetFloat (int nameID ); Parameters Parameter Description nameID The name ID of the property retrieved by Shader.PropertyToID . name The name of the property. Description Get a float from the pr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_47f2d1797ecc
unity_docs
rendering
What is `SpeedTreeImporter.enableBump` in Unity? Explain its purpose and usage.
SpeedTreeImporter.enableBump public bool[] enableBump ; Description Gets and sets an array of booleans to enable normal mapping for each LOD. Because normal mapping comes with an increased performance cost, you may want to only render normal maps on the SpeedTree assets that are nearest to the player. You can ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f759da13a51a
unity_docs
rendering
What is `ParticleSystem.RotationOverLifetimeModule.enabled` in Unity? Explain its purpose and usage.
ParticleSystem.RotationOverLifetimeModule.enabled public bool enabled ; Description Specifies whether the RotationOverLifetimeModule is enabled or disabled. Additional resources: ParticleSystem.rotationOverLifetime . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSyste...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5e7db8a2a527
unity_docs
scripting
What is `UIElements.LayerMaskField.ctor` in Unity? Explain its purpose and usage.
LayerMaskField Constructor Declaration public LayerMaskField (int defaultMask ); Parameters Parameter Description defaultMask The mask to use for a first selection. Description Constructor of the field. Declaration public LayerMaskField (string label , int defaultMask ); Parameters Parameter De...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_db3c48163822
github
scripting
Write a Unity C# script called I Game Object Factory
```csharp using TinyECS.Interfaces; using UnityEngine; namespace TinyECSUnityIntegration.Interfaces { /// <summary> /// interface IGameObjectFactory /// /// The interface represents a factory of objects of GameObject type. Use /// the implementation of this interface should be used as a replace...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.