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_558fbf9e5e69
unity_docs
input
What is `Experimental.GraphView.EdgeConnector_1.OnMouseDown` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeConnector<T0>.OnMouseDown Declaration protected void OnMouseDown ( UIElements.MouseDownEvent e ); Parameters Parameter Description e The event. Description Called on mouse down event.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b3188f141417
unity_docs
editor
What is `EditorUserBuildSettings.movePackageToDiscOuterEdge` in Unity? Explain its purpose and usage.
EditorUserBuildSettings.movePackageToDiscOuterEdge public static bool movePackageToDiscOuterEdge ; Description Places the package on the outer edge of the disk. This can make the first load faster at the expense of a larger ISO image.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_63183dbfad39
unity_docs
editor
Show me a Unity C# example demonstrating `EditorWindow.OnProjectChange`.
Change message is used to report when the items in the Project window change. Changes can include examples such as new GameObjects or Materials being added to the project. Additionally, adding folders with no contents will work as expected. As a final example OnProjectChange will be used to see any changes in th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bc29b4022761
unity_docs
math
What is `TestTools.Coverage.GetStatsFor` in Unity? Explain its purpose and usage.
Coverage.GetStatsFor Declaration public static TestTools.CoveredMethodStats GetStatsFor (MethodBase method ); Parameters Parameter Description method The method to get coverage statistics for. Returns CoveredMethodStats Coverage summary. Description Returns the coverage summary for the specified me...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e6ede2fdc169
unity_docs
editor
Show me a Unity code example for 'Troubleshooting the Linux Editor issues'.
limit in the current Editor session Increasing the maximum open file limit system wide ## Increase the maximum open file limit current Editor session If you’re using a terminal to open the Editor, then you can increase the maximum open file limit in the current Editor session by following these steps: In the terminal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7d074efbad31
unity_docs
rendering
What is `Font.characterInfo` in Unity? Explain its purpose and usage.
Font.characterInfo public characterInfo[] characterInfo ; Description Access an array of all characters contained in the font texture. You can read this if you want to render the font texture using custom generated Meshes, or you can set it when you want to build your own custom font assets from scripts (or mod...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0feaeffbb317
unity_docs
ui
What is `UIElements.VisualElementExtensions.WorldToLocal` in Unity? Explain its purpose and usage.
VisualElementExtensions.WorldToLocal Declaration public static Vector2 WorldToLocal ( UIElements.VisualElement ele , Vector2 p ); Parameters Parameter Description ele The element to use as a reference for the local space. p The point to transform, in world space. Returns Vector2 A point in the lo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ed5c32b789e8
unity_docs
physics
What is `LowLevelPhysics.TriangleMeshGeometry` in Unity? Explain its purpose and usage.
TriangleMeshGeometry struct in UnityEngine.LowLevelPhysics / Implemented in: UnityEngine.PhysicsModule Implements interfaces: IGeometry Description Contains the basic geometric shape of a non-convex mesh (sometimes known as a triangle mesh). The only way to retrieve this shape is to use the MeshCollider.Geomet...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_982c85173185_doc_8
github
scripting
What does `IsPointerOverUIObject` do in this Unity script? Explain its purpose and signature.
Checks if the the current input is over canvas UI Signature: ```csharp public bool IsPointerOverUIObject() ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9339e2c3f083
unity_docs
editor
What is `PlayModeStateChange.EnteredPlayMode` in Unity? Explain its purpose and usage.
PlayModeStateChange.EnteredPlayMode Description Occurs during the next update of the Editor application if it is in play mode and was previously in edit mode. In this condition both EditorApplication.isPlaying and EditorApplication.isPlayingOrWillChangePlaymode are true . Because this event is synchronized wit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cb0771dc6755
unity_docs
editor
What is `Device.SystemInfo.processorModel` in Unity? Explain its purpose and usage.
SystemInfo.processorModel public static string processorModel ; Description This has the same functionality as SystemInfo.processorModel and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a1d6077a660e
unity_docs
rendering
Explain 'CameraEvent and LightEvent events order reference for the Built-In Render Pipeline' in Unity.
## CameraEvent The order of execution for CameraEvents depends on the rendering path that your Project uses. ## Deferred rendering path BeforeGBuffer : Unity renders opaque geometry AfterGBuffer : Unity resolves depth. BeforeReflections : Unity renders default reflections, and Reflection Probe reflections. AfterRefl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e34fac8bab4
unity_docs
xr
What is `Networking.UnityWebRequest.disposeUploadHandlerOnDispose` in Unity? Explain its purpose and usage.
UnityWebRequest.disposeUploadHandlerOnDispose public bool disposeUploadHandlerOnDispose ; Description If true, any UploadHandler attached to this UnityWebRequest will have UploadHandler.Dispose called automatically when UnityWebRequest.Dispose is called. Default: true. If no UploadHandler is attached ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_03a0dae35c23
unity_docs
editor
What is `CacheServerValidationMode` in Unity? Explain its purpose and usage.
CacheServerValidationMode enumeration Description Options for the accelerate server validation mode. Use this enum with EditorSettings.cacheServerValidationMode to select the Accelerator server validation mode for the project. Used in conjunction with the Accelerator server Accelerator server settings Protobuf...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3243e8c9585e
unity_docs
scripting
What is `GradientColorKey.ctor` in Unity? Explain its purpose and usage.
GradientColorKey Constructor Declaration public GradientColorKey ( Color col , float time ); Parameters Parameter Description color Color of key. time Time of the key (0 - 1). Description Gradient color key.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c778ba739b56
unity_docs
scripting
Explain 'Performing a search' in Unity.
Search Providers use the fetchItems function to search for items and filter the results. The fetchItems function has the following signature: ```csharp // context: the necessary search context (for example, tokenized search and // sub-filters). // items: list of items to populate (if not using the asynchronous api) // ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_158540dfcdb8
unity_docs
editor
What are the parameters of `iOS.Xcode.PBXProject.ContainsFramework` in Unity?
Returns bool Returns true if the given framework is a dependency of the given target. Description Checks whether the given system framework is a dependency of a target. The function assumes system frameworks are located in System/Library/Frameworks in the SDK source tree. ```csharp using UnityEngine; using UnityEditor;...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_df165e046293
unity_docs
scripting
Show me a Unity C# example demonstrating `Mesh.RecalculateNormals`.
ate the normals to reflect the change. Normals are calculated from all shared vertices. Imported Meshes sometimes don't share all vertices. For example, a vertex at a UV seam is split into two vertices, so the RecalculateNormals function creates normals that are not smooth at the UV seam. Note that RecalculateNormals d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fac20fb20f0a
unity_docs
physics
What is `Physics.improvedPatchFriction` in Unity? Explain its purpose and usage.
Physics.improvedPatchFriction public static bool improvedPatchFriction ; Description Enables an improved patch friction mode that guarantees static and dynamic friction do not exceed analytical results. This improved mode only applies when patch friction is enabled, otherwise it has no effect. The physics engin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_06480a3c222f
unity_docs
editor
In Unity's 'Set up your environment for QNX', what is 'Set the environment variables' and how does it work?
After you have installed the Unity Editor, you will need to set the environment variables. Open a terminal window and run one of the following commands to set the environment variables in the local shell and start the Editor from there. qnxsdp-env.bat (Windows) source path/qnxsdp-env.sh (Linux and macOS) Alternatively,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8e3fdfa6798
unity_docs
xr
Show me a Unity C# example demonstrating `Search.SearchFlags.Sorted`.
SearchFlags.Sorted Description Fetched items are sorted by the search service. ```csharp using System; using System.Collections; using System.Collections.Generic; using UnityEditor; using UnityEditor.Search; using UnityEngine; public class SearchFlags_Sorted { [MenuItem("Examples/SearchFlags/Sorted")] public sta...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_32618ec55b47
unity_docs
ui
In Unity's 'UPM package Asset Store publishing workflow', what is 'UPM package and products' and how does it work?
The UPM publishing workflow introduces the concept of a product. A product is different from a package in the following ways: A product is a container that can include one or more UPM packages. Customers can get a product from the Asset Store. A package stores scripts , features, and assets for Unity, including Editor ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28d9903f4728
unity_docs
editor
What is `AssetDatabase.importPackageFailed` in Unity? Explain its purpose and usage.
AssetDatabase.importPackageFailed Parameters Parameter Description value Name of package. Description Callback raised whenever a package import failed. Includes an error message to give a reason for the failure. ```csharp using UnityEditor; using UnityEngine;[InitializeOnLoad] public class AssetDatabaseExampl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8e64fe6d08d
unity_docs
rendering
What is `ParticleSystemRenderer.GetMeshes` in Unity? Explain its purpose and usage.
ParticleSystemRenderer.GetMeshes Declaration public int GetMeshes (out Mesh[] meshes ); Parameters Parameter Description meshes An array this function populates with the list of Meshes the ParticleSystemRenderer uses for particle Mesh selection. If the array is smaller than the number of Meshes, this functio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_efb655d4044a
unity_docs
rendering
What is `ParticleSystem.ShapeModule.radiusThickness` in Unity? Explain its purpose and usage.
ParticleSystem.ShapeModule.radiusThickness public float radiusThickness ; Description Radius thickness of the shape's edge from which to emit particles. When emitting from the edge of Circles, Cones, and Spheres, you can use this to add a thicker border to the edge where the system emits particles. Additional ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a482f8c1fbd
unity_docs
scripting
What is `TextAreaAttribute.ctor` in Unity? Explain its purpose and usage.
TextAreaAttribute Constructor Declaration public TextAreaAttribute (); Declaration public TextAreaAttribute (int minLines , int maxLines ); Parameters Parameter Description minLines The minimum amount of lines the text area will use. maxLines The maximum amount of lines the text area can show before i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d1e7172105b
unity_docs
xr
What is `Windows.WebCam.PhotoCaptureFrame.TryGetProjectionMatrix` in Unity? Explain its purpose and usage.
PhotoCaptureFrame.TryGetProjectionMatrix Declaration public bool TryGetProjectionMatrix (float nearClipPlane , float farClipPlane , out Matrix4x4 projectionMatrix ); Declaration public bool TryGetProjectionMatrix (out Matrix4x4 projectionMatrix ); Parameters Parameter Description nearClipPlane The...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9d5914aa6ed1
unity_docs
ui
What is `UIElements.VisualElement.SetBinding` in Unity? Explain its purpose and usage.
VisualElement.SetBinding Declaration public void SetBinding ( UIElements.BindingId bindingId , UIElements.Binding binding ); Parameters Parameter Description bindingId The binding ID. binding The binding object. Description Assigns a binding between a target and a source. Passing a value of nul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_212fee060349
unity_docs
rendering
What is `AssetDatabase.GetAssetDependencyHash` in Unity? Explain its purpose and usage.
AssetDatabase.GetAssetDependencyHash Declaration public static Hash128 GetAssetDependencyHash (string path ); Declaration public static Hash128 GetAssetDependencyHash (GUID guid ); Parameters Parameter Description path Project relative path to the asset. guid GUID of the asset. Returns Hash128 ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c8f5084d490
unity_docs
math
Show me a Unity C# example demonstrating `Search.QueryEngine_1`.
QueryEngine<T0> class in UnityEditor.Search Description A QueryEngine defines how to build a query from an input string. It can be customized to support custom filters and operators. <TData>: The filtered data type. ```csharp using System.Collections.Generic; using System.Linq; using UnityEditor; using UnityEdit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_79944978b428
unity_docs
editor
Explain 'Scriptable Build Pipeline' in Unity.
com.unity.scriptablebuildpipeline ## Description The Scriptable Build Pipeline moves the asset bundle build pipeline to C#. Use the pre-defined build flows, or create your own using the divided up APIs. This system improves build time, fixes incremental build, and provides greater flexibility. ## Released for Unity ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2106030d68cd
unity_docs
scripting
Give me an overview of the `SpritePackingMode` class in Unity.
SpritePackingMode enumeration Description Sprite packing modes for the Sprite Packer. Properties Property Description Tight Tight mesh based packing. Rectangle Alpha-cropped rectangle packing.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8eaff881b318
unity_docs
scripting
What is `PackageManager.PackageInfo.git` in Unity? Explain its purpose and usage.
PackageInfo.git public PackageManager.GitInfo git ; Description A GitInfo instance providing detailed information for a Git package. This value is null if PackageInfo.source is not PackageSource.Git .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_96bd32b26d8b
unity_docs
xr
In Unity's 'Dynamic heap allocator example', what is 'Example usage report' and how does it work?
An example usage report for the dynamic heap allocator is as follows: ``` [ALLOC_DEFAULT_MAIN] Peak usage frame count: [16.0 MB-32.0 MB]: 497 frames, [32.0 MB-64.0 MB]: 1 frames Requested Block Size 16.0 MB Peak Block count 2 Peak Allocated memory 54.2 MB Peak Large allocation bytes 40.2 MB ``` In this example, the Two...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a74d94220aca
unity_docs
animation
What is `Animations.AnimatorConditionMode` in Unity? Explain its purpose and usage.
AnimatorConditionMode enumeration Description The mode of the condition. Properties Property Description If The condition is true when the parameter value is true. IfNot The condition is true when the parameter value is false. Greater The condition is true when parameter value is greater than the threshold. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fa450404568c
unity_docs
xr
In Unity's 'Project manifest file', what is 'Properties' and how does it work?
All properties are optional. However, if your project manifest file does not contain any values, the Package Manager window doesn’t load, and the Package Manager doesn’t load any packages. Key JSON Type Description dependencies Object Collection of packages required for your project. This includes only direct dependenc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9711edd6922a
unity_docs
rendering
What is `Device.SystemInfo.graphicsShaderLevel` in Unity? Explain its purpose and usage.
SystemInfo.graphicsShaderLevel public static int graphicsShaderLevel ; Description This has the same functionality as SystemInfo.graphicsShaderLevel and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7ac40618e8c2
unity_docs
scripting
What is `Experimental.GraphView.GraphElement` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphElement class in UnityEditor.Experimental.GraphView / Inherits from: UIElements.VisualElement Implements interfaces: ISelectable Description Base class for main GraphView VisualElements. Properties Property Descripti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_119c66d7dcbe
unity_docs
physics
Give me an overview of the `PhysicsScene2D` class in Unity.
PhysicsScene2D struct in UnityEngine / Implemented in: UnityEngine.Physics2DModule Description Represents a single instance of a 2D physics Scene. A 2D physics Scene owns all 2D physics component objects added to it and can perform a simulation of them as well as execute queries against them. All of this functi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c2852abd5b91_doc_4
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Manages the state of camera passthrough on the device. Signature: ```csharp public class PassthroughManager : BasePassthroughManager ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_8802554d23de
unity_docs
math
What is `Rendering.RayTracingMeshInstanceConfig.accelerationStructureBuildFlagsOverride` in Unity? Explain its purpose and usage.
RayTracingMeshInstanceConfig.accelerationStructureBuildFlagsOverride public bool accelerationStructureBuildFlagsOverride ; Description Whether to override the build flags specified when creating a RayTracingAccelerationStructure . If you set this value to true , Unity uses RayTracingMeshInstanceConfig.accele...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8b85cfa5b1b1
unity_docs
editor
Give me an overview of the `InitializeOnLoadAttribute` class in Unity.
InitializeOnLoadAttribute class in UnityEditor Description Allows you to initialize an Editor class when Unity loads, and when your scripts are recompiled. Static constructors with this attribute are called when scripts in the project are recompiled, also known as a Domain Reload ). This happens when: Unity fir...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_95a1a9e2076e
unity_docs
animation
What is `Animator.humanScale` in Unity? Explain its purpose and usage.
Animator.humanScale public float humanScale ; Description Returns the scale of the current Avatar for a humanoid rig, (1 by default if the rig is generic). The scale is relative to Unity's Default Avatar.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bdd7a7ee92df
unity_docs
scripting
What is `InstantiateParameters.worldSpace` in Unity? Explain its purpose and usage.
InstantiateParameters.worldSpace public bool worldSpace ; Description Choose between world space or local space. If set, the position and rotation provided to the method will be treated as world space. If no position and rotation are passed, the world position and rotation of the instance will match the world p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09a34234e812
unity_docs
math
What is `HandleUtility.ClosestPointToDisc` in Unity? Explain its purpose and usage.
HandleUtility.ClosestPointToDisc Declaration public static Vector3 ClosestPointToDisc ( Vector3 center , Vector3 normal , float radius ); Description Get the point on an disc (in 3D space) which is closest to the current mouse position. This function takes the disc defined by its parameters and "flatten...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f17cd2bba45
unity_docs
rendering
What is `ParticleSystem.MainModule.startRotationX` in Unity? Explain its purpose and usage.
ParticleSystem.MainModule.startRotationX public ParticleSystem.MinMaxCurve startRotationX ; Description The initial rotation of particles around the x-axis when emitted. Note that you should specify the value in radians. Additional resources: MinMaxCurve . ```csharp using UnityEngine; using System.Collecti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_06fb2af21915
unity_docs
scripting
What is `CreateAssetObjectEventArgs.ctor` in Unity? Explain its purpose and usage.
CreateAssetObjectEventArgs Constructor Declaration public CreateAssetObjectEventArgs (GUID guid , int instanceId , SceneManagement.Scene scene ); Parameters Parameter Description guid The GUID of the new asset. instanceId The instance ID of the modified asset. scene The Scene that contains the ne...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ce2ba423b42
unity_docs
rendering
What is `Handles.elementPreselectionColor` in Unity? Explain its purpose and usage.
Handles.elementPreselectionColor public static Color elementPreselectionColor ; Description Color to use to highlight an unselected object currently under the mouse pointer in a custom Edit Mode.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b9ac6ffddbe1
unity_docs
xr
Explain 'PolySpatial visionOS' in Unity.
com.unity.polyspatial.visionos ## Description Unity PolySpatial integration package to support shared and immersive mode rendering on Apple visionOS. Unity PolySpatial and visionOS support is only available to Unity Pro, Unity Enterprise, and Unity Industry users. Learn more about these plans at unity.com/pricing. #...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_92d1a4fc3e62
unity_docs
scripting
What is `AndroidJavaProxy.toString` in Unity? Explain its purpose and usage.
AndroidJavaProxy.toString Declaration public string toString (); Returns string Returns C# class name + " <c# proxy java object>". Description The equivalent of the java.lang.Object toString() method.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_45a5d894158d
unity_docs
scripting
What are the parameters of `Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetricsFilters.ctor` in Unity?
Description Constructor for an instance of the Summary Metrics Filters, used to filter the metrics data that is included in the calculation of a summary. The constructor takes one value of a filter. To take multiple values for the same filter, you can use the array constructor (below). For multiple filters, use the Set...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a1732ec1822f
unity_docs
rendering
Show me a Unity C# example demonstrating `Material.GetFloat`.
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 named float value. Additional resourc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8bbff0a7846e
unity_docs
rendering
What is `Rendering.RenderTargetBlendState.colorBlendOperation` in Unity? Explain its purpose and usage.
RenderTargetBlendState.colorBlendOperation public Rendering.BlendOp colorBlendOperation ; Description Operation used for blending the color (RGB) channel. Additional resources: ShaderLab: Blending .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7ac7ee9bd44a
unity_docs
editor
What is `WebGLInput.stickyCursorLock` in Unity? Explain its purpose and usage.
WebGLInput.stickyCursorLock public static bool stickyCursorLock ; Description Set cursor lock behavior to be "sticky" or "unsticky". Sticky cursor lock means if the browser unlocks the cursor when the user presses the ESC key, the cursor will remain locked in Unity. To match the browser's behavior, this propert...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_118dfc5c4569
unity_docs
rendering
Explain 'Activate and deactivate search providers' in Unity.
You can manage search providers at two levels: At the Search window level, you can toggle search providers to be active or inactive. You can open different Search windows with different active search providers at the same time. At the project level, you can add custom search providers. ## Toggle providers on and off i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0d5a928a448c
unity_docs
physics
What is `Rigidbody.solverVelocityIterations` in Unity? Explain its purpose and usage.
Rigidbody.solverVelocityIterations public int solverVelocityIterations ; Description The solverVelocityIterations affects how how accurately Rigidbody joints and collision contacts are resolved. Overrides Physics.defaultSolverVelocityIterations . Must be positive. Increasing this value will result in higher a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d12bbb3b6532
unity_docs
rendering
What is `Material.globalIlluminationFlags` in Unity? Explain its purpose and usage.
Material.globalIlluminationFlags public MaterialGlobalIlluminationFlags globalIlluminationFlags ; Description Defines how the material should interact with lightmaps and lightprobes. A custom shader GUI will usually set these values based on user input.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_b7cfc526d0ed_doc_0
github
scripting
What does `Instance` do in this Unity script? Explain its purpose and signature.
Get or create the singleton instance Signature: ```csharp public static UpdateManager Instance => (ApplicationUtils.IsQuitting || _instance != null) ? _instance : (_instance = CreateInstance()); ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_481b3abbe217
unity_docs
audio
Show me a Unity C# example demonstrating `Collision.relativeVelocity`.
Collision.relativeVelocity public Vector3 relativeVelocity ; Description The relative linear velocity of the two colliding objects (Read Only). ```csharp // Play a sound when we hit an object with a big velocity using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { AudioSour...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab493a86bd2d
unity_docs
editor
What are the parameters of `Search.SearchIndexer.AddWord` in Unity?
Description Adds a new word coming from a document to the index. The word is added with multiple variations allowing partial search. ```csharp using UnityEditor; using UnityEditor.Search; using UnityEngine; static class Example_SearchIndexer_AddWord { [MenuItem("Examples/SearchIndexer/AddWord")] public static ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_240df9c6cb6a
unity_docs
scripting
What is `AndroidJNI.IsAssignableFrom` in Unity? Explain its purpose and usage.
AndroidJNI.IsAssignableFrom Declaration public static bool IsAssignableFrom (IntPtr clazz1 , IntPtr clazz2 ); Description Determines whether an object of clazz1 can be safely cast to clazz2 . Additional resources: Java Native Interface Specification (Oracle)
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_35e2ed543033
unity_docs
rendering
What is `TransparencySortMode.Orthographic` in Unity? Explain its purpose and usage.
TransparencySortMode.Orthographic Description Orthographic transparency sorting mode. Transparent objects will be sorted based on distance along the camera's view. Additional resources: Camera.transparencySortMode .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a203cf72d258
unity_docs
scripting
What is `Progress.Status` in Unity? Explain its purpose and usage.
Status enumeration Description Indicates the status of a progress indicator's associated task. Properties Property Description Running Indicates that the task is still running. Succeeded Indicates that the task succeeded. Failed Indicates that the task failed. Canceled Indicates that the task was canceled. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_be07cf86412e
unity_docs
scripting
What is `Video.VideoClip.GetAudioChannelCount` in Unity? Explain its purpose and usage.
VideoClip.GetAudioChannelCount Declaration public ushort GetAudioChannelCount (ushort audioTrackIdx ); Parameters Parameter Description audioTrackIdx Use this index to specify which audio track in the video to use. Returns ushort The number of channels. Description Returns the number of channels in t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28e8383b6605
unity_docs
scripting
What is `AssetBundleUnloadOperation` in Unity? Explain its purpose and usage.
AssetBundleUnloadOperation class in UnityEngine / Inherits from: AsyncOperation / Implemented in: UnityEngine.AssetBundleModule Description Async unload operation for an AssetBundle . Public Methods Method Description WaitForCompletion Synchronously waits for the operation to complete. Inherited Members ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_fac968ae6e3f
github
scripting
Write a Unity C# script called Layout Switcher
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.UI; namespace UIStateSwitcher { public class LayoutSwitcher : SwitchableElement { [SerializeField] private HorizontalOrVerticalLayoutGroup layoutGroup; [SerializeField] private L...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_643ebfb7c494
unity_docs
scripting
What is `Experimental.GraphView.Scope.GetPosition` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Scope.GetPosition Declaration public Rect GetPosition (); Returns Rect The geometry. Description Returns the geometry of the Scope.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_41ab7a605045
github
scripting
Write a Unity Editor script for Scene Script Updater
```csharp using System.Collections.Generic; using System.Linq; using Baxter.ClusterScriptExtensions.Editor.Localization; using ClusterVR.CreatorKit.Gimmick.Implements; using ClusterVR.CreatorKit.Item.Implements; using UnityEditor; using UnityEditor.SceneManagement; using UnityEngine; using UnityEngine.SceneManagement; ...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_3c0f2a07e8a5
unity_docs
rendering
What is `Rendering.RayTracingMeshInstanceConfig.renderingLayerMask` in Unity? Explain its purpose and usage.
RayTracingMeshInstanceConfig.renderingLayerMask public uint renderingLayerMask ; Description A mask that you can access in HLSL with unity_RenderingLayer built-in shader uniform. ``` uniform float4 unity_RenderingLayer;// HLSL usage example: uint renderingLayerMask = asuint(unity_RenderingLayer.x); ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1103aad2dbdc
unity_docs
scripting
In Unity's 'Gizmos introduction', what is 'Icons' and how does it work?
You can display icons in the Game view or Scene view as flat, billboard-style overlays. These help indicate a GameObject’s position while you work on your game. The Camera icon and Light icon are examples of built-in icons. You can also assign custom icons to GameObjects or individual scripts. For more information, ref...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cfcb79ef5cae
unity_docs
rendering
In Unity's 'Video Player component reference', what is 'Update Mode dropdown' and how does it work?
The following options are available in the Update Mode dropdown. Value Description DSP Time Use the same clock source that processes audio. Game Time Use the same clock source as the game clock. This clock source is affected by the time scaling and capture frame rate settings . Unscaled Game Time Use the same clock sou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2874e880e774
unity_docs
xr
What is `PackageManager.Client.Add` in Unity? Explain its purpose and usage.
Client.Add Declaration public static PackageManager.Requests.AddRequest Add (string identifier ); Parameters Parameter Description identifier A string representing the package to be added: - To install a specific version of a package, use a package identifier ("name@version"). This is the only way to i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_062ba94e1cbf
unity_docs
ui
In Unity's 'Package Manifest window reference', what is 'Dependencies section' and how does it work?
Lists the other packages that are dependencies for this package. Each entry consists of the official package name (for example, com.unity.probuilder ) and its version number. To add a new dependency: Select the Add ( + ) button. A new row appears in the list. Enter the package name on the left and the version on the ri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e9c0b0ff57a
unity_docs
scripting
What is `HDROutputSettings.available` in Unity? Explain its purpose and usage.
HDROutputSettings.available public bool available ; Description Describes whether HDR is currently available on your primary display and that you have HDR enabled in your Unity Project. It is true if this is the case, and false otherwise.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2e1fd5bbd865
unity_docs
rendering
What is `Rendering.RayTracingAccelerationStructure.UpdateInstancePropertyBlock` in Unity? Explain its purpose and usage.
RayTracingAccelerationStructure.UpdateInstancePropertyBlock Declaration public void UpdateInstancePropertyBlock (int handle , MaterialPropertyBlock properties ); Parameters Parameter Description handle The handle associated with a AABB or Mesh ray tracing instance. properties The additional material pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7a0ac17e6d96
github
scripting
Write a Unity C# MonoBehaviour script called Recenter Manager
```csharp /** * @file RecenterManager.cs * * @author Geoffrey Marhuenda * * @brief Helper to recenter the user at the start of the scene. */ using UnityEngine; namespace Lynx { public class RecenterManager : MonoBehaviour { private Vector3 m_startPosition = Vector3.zero; void Start() ...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_168810b94680
unity_docs
editor
What is `Experimental.GraphView.IResizable` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. IResizable interface in UnityEditor.Experimental.GraphView Description Resizable interface. Public Methods Method Description OnResized Called when resize is completed. OnStartResize Called when resize is started.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_37f5c2e48b9f
unity_docs
scripting
Show me a Unity C# example demonstrating `Random.insideUnitCircle`.
Random.insideUnitCircle public static Vector2 insideUnitCircle ; Description Returns a random point inside or on a circle with radius 1.0 (Read Only). Note that the probability space includes the perimeter of the circle because value , which is inclusive to 1.0, is used to acquire a random radius. ```cshar...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_65423099e7ff
unity_docs
physics
What are the parameters of `PhysicsShapeGroup2D.DeleteShape` in Unity?
Description When destroying a shape at the specified shapeIndex , all other shapes that exist above the specified shapeIndex will have their shape indices updated appropriately. ```csharp using UnityEngine; using UnityEngine.Assertions;public class Example : MonoBehaviour { void Start() { // Create a sh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_864f676ba074
unity_docs
scripting
What is `ScreenOrientation` in Unity? Explain its purpose and usage.
ScreenOrientation enumeration Description Describes screen orientation. Currently this is only relevant on mobile devices. Additional resources: Screen.orientation . Properties Property Description Portrait Portrait orientation. PortraitUpsideDown Portrait orientation, upside down. LandscapeLeft Landscape o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1396177efbc3
unity_docs
editor
In Unity's 'AI Navigation', what is 'Keywords' and how does it work?
carving , mesh , navigation , navmesh , NavMesh , navmesh agent , navmesh link , navmeshlink , navmesh modifier , navmeshmodifier , navmesh modifier volume , navmeshmodifiervolume , navmesh obstacle , navmesh surface , navmeshsurface , offmesh link , off-mesh link , pathfinding
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_69177777a1eb
unity_docs
editor
Show me a Unity C# example demonstrating `Profiling.FrameDataView.GetUnityObjectInfo`.
gine.Object instance in the profiler capture. The Profiler sample can be associated with an instance of an object instance that represents an Asset, a GameObject, or anything that is derived from UnityEngine.Object. This information is available as a part of sample metadata. To get this metadata you can use RawFrameD...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8372ec3536de
unity_docs
ui
What is `UIElements.VisualElement.enabledSelf` in Unity? Explain its purpose and usage.
VisualElement.enabledSelf public bool enabledSelf ; Description Returns true if the VisualElement is enabled locally. This flag isn't changed if the VisualElement is disabled implicitly by one of its parents. To verify this, use enabledInHierarchy.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_be6cffca71f1
unity_docs
scripting
Show me a Unity C# example demonstrating `RuntimePlatform.Switch`.
RuntimePlatform.Switch Description In the player on Nintendo Switch. Additional resources: RuntimePlatform , Platform dependent compilation . ```csharp using UnityEngine;public class ExampleClass : MonoBehaviour { void Example() { if (Application.platform == RuntimePlatform.Switch) Debug.Log("Do something sp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2f52d5ee06c
unity_docs
editor
What is `EditorUserBuildSettings.waitForPlayerConnection` in Unity? Explain its purpose and usage.
EditorUserBuildSettings.waitForPlayerConnection public static bool waitForPlayerConnection ; Description Sets the Player to wait for player connection on player start. Additional resources: PlayerConnection .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc8004423a82
unity_docs
rendering
What is `Material.HasInt` in Unity? Explain its purpose and usage.
Material.HasInt Declaration public bool HasInt (string name ); Declaration public bool HasInt (int nameID ); Parameters Parameter Description nameID The name ID of the property. Use Shader.PropertyToID to get this ID. name The name of the property. Returns bool Returns true if the ShaderLab fil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d7e6d8f82eb7
github
scripting
Write a Unity C# ScriptableObject for Buildable Rule Definition
```csharp using FactoryMustScale.Simulation; using UnityEngine; namespace FactoryMustScale.Authoring { [System.Serializable] public struct BuildableRuleDefinition { public GridStateId StateId; public TerrainTypeMask AllowedTerrains; public ResourceTypeMask AllowedResources; } ...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_bb88b06eba56
unity_docs
performance
What is `Unity.Burst.BurstAuthorizedExternalMethodAttribute` in Unity? Explain its purpose and usage.
BurstAuthorizedExternalMethodAttribute class in Unity.Burst / Implemented in: UnityEngine.CoreModule Description The BurstAuthorizedExternalMethod attribute lets you mark a function as being authorized for Burst to call from within a static constructor. Normally, Burst will not call into an external method whi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b93a52e2f90c
unity_docs
scripting
What are the parameters of `VersionControl.Provider.PreCheckoutCallback` in Unity?
Description Delegate for a user-supplied callback to be called before Version Control Checkout. A PreCheckoutCallback may be set to enable the following: Permit the check out by returning true from the callback. Prevent the check out by returning false from the callback. Modify the list of Assets to be checked out (you...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c2e84a0e1757
unity_docs
editor
What is `EditorGUIUtility.ObjectContent` in Unity? Explain its purpose and usage.
EditorGUIUtility.ObjectContent Declaration public static GUIContent ObjectContent ( Object obj , Type type ); Description Return a GUIContent object with the name and icon of an Object. If the object is null, the icon will be picked according to type. Object Content usage. ```csharp // Simple Editor Scri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_06e54b55d840
unity_docs
scripting
What is `Rendering.RenderPipelineGraphicsSettingsExtensions.NotifyValueChanged` in Unity? Explain its purpose and usage.
RenderPipelineGraphicsSettingsExtensions.NotifyValueChanged Declaration public static void NotifyValueChanged ( Rendering.IRenderPipelineGraphicsSettings settings , string propertyName ); Parameters Parameter Description settings The settings where to notify. propertyName The name of the changed field. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_00fd6e157679
unity_docs
math
What is `UIElements.Painter2D.LineTo` in Unity? Explain its purpose and usage.
Painter2D.LineTo Declaration public void LineTo ( Vector2 pos ); Parameters Parameter Description pos The end position of the line. Description Adds a straight line to the current sub-path to the provided position.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d40b6512f9b5
unity_docs
physics
What is `Rigidbody.SweepTestAll` in Unity? Explain its purpose and usage.
Rigidbody.SweepTestAll Declaration public RaycastHit[] SweepTestAll ( Vector3 direction , float maxDistance = Mathf.Infinity, QueryTriggerInteraction queryTriggerInteraction = QueryTriggerInteraction.UseGlobal); Parameters Parameter Description direction The direction into which to sweep the rigidbod...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b349ddabca2b
unity_docs
scripting
What is `RigidbodyConstraints.FreezeRotation` in Unity? Explain its purpose and usage.
RigidbodyConstraints.FreezeRotation Description Freeze rotation along all axes. ```csharp //Attach this script to a GameObject with a Rigidbody. Press the up and down keys to move the Rigidbody up and down. //Press the space key to freeze all rotations, but notice the positions still change.using UnityEngine;public...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_114e3cf6add6
unity_docs
math
What is `Cloth.vertices` in Unity? Explain its purpose and usage.
Cloth.vertices public Vector3[] vertices ; Description The current vertex positions of the cloth object. This gives you read access to the vertex positions of the cloth object, so you can analyse it's current simulation state. Note that the vertex indices may not necessarily correspond to the indices of the so...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_84acc3e9df9d
unity_docs
scripting
What is `HDROutputSettings.displayColorGamut` in Unity? Explain its purpose and usage.
HDROutputSettings.displayColorGamut public ColorGamut displayColorGamut ; Description The ColorGamut used to output to the active HDR display. Accessing this member results in an exception if HDR is not available on the display. Use HDROutputSettings.available for the display to check that HDR is availabl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_85858d279c61
unity_docs
editor
What is `AI.NavMeshBuildDebugFlags.Regions` in Unity? Explain its purpose and usage.
NavMeshBuildDebugFlags.Regions Description The segmentation of the traversable surfaces into smaller areas necessary for producing simple polygons. Additional resources: NavMeshBuildSettings.debug , NavMeshEditorHelpers.DrawBuildDebug .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_76c1bcd5dae8
unity_docs
rendering
What is `Camera.stereoTargetEye` in Unity? Explain its purpose and usage.
Camera.stereoTargetEye public StereoTargetEyeMask stereoTargetEye ; Description Defines which eye of a VR display the Camera renders into. This property is only used when Virtual Reality is enabled. The default is to render into both eyes. The values passed to stereoTargetEye are found in the StereoTargetEy...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0e543ea90a7a
unity_docs
editor
What is `Search.IndexingOptions` in Unity? Explain its purpose and usage.
IndexingOptions enumeration Description Use Indexing options to specify the contents of your search index. Properties Property Description None Do not include additional indexing options. Types Include additional types of information in your Asset index. Properties Include Asset serialized properties in your ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_79c31e79fc0f
unity_docs
editor
What is `AssetImporters.AssetImporterEditor.OnInspectorGUI` in Unity? Explain its purpose and usage.
AssetImporterEditor.OnInspectorGUI Declaration public void OnInspectorGUI (); Description Override this method to create your own Inpsector GUI for a ScriptedImporter. For the OnInspectorGUI Undo/Redo and cancel feature to work in the Inspector, you must either call ApplyRevertGUI or override needsApplyRevert t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.