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_41faff7b5500
unity_docs
scripting
What is `Tilemaps.Tilemap` in Unity? Explain its purpose and usage.
Tilemap class in UnityEngine.Tilemaps / Inherits from: GridLayout / Implemented in: UnityEngine.TilemapModule Description The Tilemap stores Sprite s in a layout marked by a Grid component. Properties Property Description animationFrameRate The frame rate for all Tile animations in the Tilemap. cellBou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f23f424d770c
unity_docs
physics
What is `PhysicsVisualizationSettings.QueryFilter.Overlap` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.QueryFilter.Overlap Description Whether the filter includes overlap type queries. For example, overlap type queries include Physics.OverlapBox and Physics.OverlapSphereNonAlloc .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1db129bd9daf
unity_docs
scripting
Give me an overview of the `VideoEncodingProfile` class in Unity.
VideoEncodingProfile enumeration Description Use the options in this enumeration to change the encoder profile. H.264 profiles (Baseline, Main, and High) are compression and encoding standards that determine how the MediaEncoder compresses and encodes video files during recording. You can use the MediaEncoder ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6bdb2e16b792
github
scripting
Write a Unity C# script called Editable Ordered Dictionary_string_Texture2D
```csharp // Copyright (c) Rotorz Limited. All rights reserved. // Licensed under the MIT license. using System; using UnityEngine; namespace Rotorz.Games.Collections { /// <summary> /// An object that allows users to edit <see cref="OrderedDictionary_string_Texture2D"/> /// objects when using the Unity i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9533ba2bd317
unity_docs
scripting
What is `ComputeBufferMode.Dynamic` in Unity? Explain its purpose and usage.
ComputeBufferMode.Dynamic Description Dynamic buffer. Use this if the buffer is modified often by the CPU (by calls to ComputeBuffer.SetData or ComputeBuffer.BeginWrite ). Unity typically stores buffers of this type into GPU-visible CPU memory, to enable fast CPU uploads at the cost of GPU performance when it ac...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1b760b35a5a1
unity_docs
rendering
Explain 'Check or write to the stencil buffer in a shader' in Unity.
The stencil buffer stores an 8-bit integer value for each pixel in the frame buffer. Before executing the fragment shader for a given pixel, the GPU can compare the current value in the stencil buffer against a given reference value. This is called a stencil test. If the stencil test passes, the GPU performs the depth ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f1408996e285
unity_docs
rendering
What is `Rendering.RayTracingAABBsInstanceConfig.materialProperties` in Unity? Explain its purpose and usage.
RayTracingAABBsInstanceConfig.materialProperties public MaterialPropertyBlock materialProperties ; Description Additional MaterialPropertyBlock properties to apply to the Material. Additional resources: RayTracingAccelerationStructure.UpdateInstancePropertyBlock .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6017bd0553c1
unity_docs
rendering
What is `Material.mainTextureScale` in Unity? Explain its purpose and usage.
Material.mainTextureScale public Vector2 mainTextureScale ; Description The scale of the main texture. By default, Unity considers a texture with the property name name "_MainTex" to be the main texture. Use the [MainTexture] ShaderLab Properties attribute to make Unity consider a texture with a differ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a0fcb5c453a4
unity_docs
rendering
Explain 'Linear textures' in Unity.
sRGB sampling allows the Unity Editor to render Shaders in linear color space when Textures are in gamma color space. When you select to work in linear color space, the Editor defaults to using sRGB sampling. If your Textures are in linear color space, you need to work in linear color space and disable sRGB sampling fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_603105427e02
unity_docs
editor
In Unity's 'Command events', what is 'ValidateCommandEvent' and how does it work?
The ValidateCommandEvent event asks an EditorWindow if it can execute a command. For example, the Editor can enable or disable a menu item based on the results from the validation command event. To verify if the Editor can execute a command: Register a callback for ValidateCommandEvent . Test the commandName property o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1660efb88140
unity_docs
editor
What is `Search.SearchIndexer.minWordIndexationLength` in Unity? Explain its purpose and usage.
SearchIndexer.minWordIndexationLength public int minWordIndexationLength ; Description Minimal indexed word size. Default is 2. ```csharp using System.Linq; using UnityEditor; using UnityEditor.Search; using UnityEngine; /// <summary> /// The property minWordIndexationLength is used to prevent indexing too man...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c2dc77d7059f
unity_docs
editor
Give me an overview of the `TooltipAttribute` class in Unity.
TooltipAttribute class in UnityEngine / Inherits from: PropertyAttribute / Implemented in: UnityEngine.CoreModule Description Specify a tooltip for a field in the Inspector window. Tooltip hovering over the class it was added to. In the following script a Tooltip is added. This provides information to the u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d44ab9e36abb
unity_docs
scripting
What is `UIElements.DoubleField.StringToValue` in Unity? Explain its purpose and usage.
DoubleField.StringToValue Declaration protected double StringToValue (string str ); Parameters Parameter Description str The string to convert. Returns double The double parsed from the string. Description Converts a string to a double.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9457e0a40fb1
unity_docs
ui
What is `GUI.contentColor` in Unity? Explain its purpose and usage.
GUI.contentColor public static Color contentColor ; Description Tinting color for all text rendered by the GUI. This gets multiplied by color . Additional resources: backgroundColor , color . Yellow content color (font) in a button. ```csharp // Tints with yellow the letters of the button.using UnityEngi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb5f40e71071
unity_docs
scripting
What are the parameters of `UIElements.MaskField.ctor` in Unity?
Description Initializes and returns an instance of MaskField. Declaration public MaskField (string label , List<string> choices , int defaultMask , Func<string,string> formatSelectedValueCallback , Func<string,string> formatListItemCallback ); Parameters Parameter Description label The text to use as a label for the fi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d3d2851181b
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.E5B9G9R9_UFloatPack32` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.E5B9G9R9_UFloatPack32 Description A three-component, 32-bit packed unsigned floating-point format that has a 5-bit shared exponent in bits 27..31, a 9-bit B component mantissa in bits 18..26, a 9-bit G component ma...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_01b059288b62
unity_docs
scripting
What is `SearchService.AdvancedObjectSelectorParameters.trackingHandler` in Unity? Explain its purpose and usage.
AdvancedObjectSelectorParameters.trackingHandler public Action<Object> trackingHandler ; Description Function to call when tracking the selection in the advanced Object Selector. Only available during AdvancedObjectSelectorEventType.OpenAndSearch . This function takes a single parameter: the object to track, o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4bda2e82a8d7
unity_docs
scripting
What is `UIElements.UQueryState_1.GetEnumerator` in Unity? Explain its purpose and usage.
UQueryState<T0>.GetEnumerator Declaration public Enumerator<T> GetEnumerator (); Returns Enumerator<T> A UQueryState_1.Enumerator instance configured to traverse the results. Description Allows traversing the results of the query with foreach without creating GC allocations.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5789d12f2e9e
unity_docs
scripting
What is `ParticleSystem.MainModule.startLifetimeMultiplier` in Unity? Explain its purpose and usage.
ParticleSystem.MainModule.startLifetimeMultiplier public float startLifetimeMultiplier ; Description A multiplier for ParticleSystem.MainModule.startLifetime . Changing this property is more efficient than accessing the entire curve, if you only want to change the overall lifetime multiplier. ```csharp using...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ddd64bc840b
unity_docs
scripting
Give me an overview of the `SpeedTreeWindAsset` class in Unity.
SpeedTreeWindAsset class in UnityEngine / Inherits from: Object / Implemented in: UnityEngine.TerrainModule Description SpeedTreeWindAsset generated by the SpeedTreeImporter, contains wind version and configuration data for SpeedTree wind simulation. Properties Property Description Version Gets or sets th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_46f704aa68a1
unity_docs
rendering
Give me an overview of the `MobileTextureSubtarget` class in Unity.
MobileTextureSubtarget enumeration Description Compressed texture format for target build platform. Additional resources: EditorUserBuildSettings.androidBuildSubtarget . Properties Property Description Generic Don't override texture compression. DXT S3 texture compression. Supported on devices with NVidia Te...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2e24b5a0a88
unity_docs
physics
What is `Physics2D.LinecastAll` in Unity? Explain its purpose and usage.
Physics2D.LinecastAll Declaration public static RaycastHit2D[] LinecastAll ( Vector2 start , Vector2 end , int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity); Parameters Parameter Description start The start point of the line in world space. en...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_35bca0f3fc86
unity_docs
ui
What is `UIElements.UxmlSerializedDataCreator.CreateUxmlSerializedData` in Unity? Explain its purpose and usage.
UxmlSerializedDataCreator.CreateUxmlSerializedData Declaration public static UIElements.VisualElement.UxmlSerializedData CreateUxmlSerializedData (Type type ); Parameters Parameter Description fullTypeName The full type name of the Type that contains the UxmlSerializedData . Belongs to a type that's acti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3eb328d511d3
unity_docs
rendering
What is `UIVertex` in Unity? Explain its purpose and usage.
UIVertex struct in UnityEngine / Implemented in: UnityEngine.TextRenderingModule Description Vertex class used by a Canvas for managing vertices. Static Properties Property Description simpleVert Simple UIVertex with sensible settings for use in the UI system. Properties Property Description color Vert...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_af85fbe3f3e9
unity_docs
editor
Explain 'Mesh data' in Unity.
Resources on the data that a mesh contains, and how to view it in the Unity Editor. Topic Description Mesh vertex data Learn about mesh vertex data, which describes a collection of positions in 3D space. Mesh topology data Learn about mesh topology data, which describes the type of face that a mesh has. Mesh index data...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_199dbaef89bd
unity_docs
rendering
In Unity's 'Batch meshes at runtime', what is 'Batch static GameObjects at runtime' and how does it work?
To batch static GameObjects at runtime, for example GameObjects you create procedurally, follow these steps: Select each mesh you want to batch, then in the Inspector window enable Read/Write enabled . Use the StaticBatchingUtility API to batch the meshes. The StaticBatchingUtility.Combine method combines GameObjects a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac52d7e0435c
unity_docs
scripting
What is `QualitySettings.DecreaseLevel` in Unity? Explain its purpose and usage.
QualitySettings.DecreaseLevel Declaration public static void DecreaseLevel (bool applyExpensiveChanges = false); Parameters Parameter Description applyExpensiveChanges Should expensive changes be applied (Anti-aliasing etc). Description Decrease the current quality level. ```csharp using UnityEngine;pub...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a5889bb29b1c_doc_27
github
scripting
What does `GetCellIndex` do in this Unity script? Explain its purpose and signature.
Gets the index to the GameObjectBrush::ref::BrushCell based on the position of the BrushCell.X Position of the BrushCell.Y Position of the BrushCell.Z Position of the BrushCell.X Size of Brush.Y Size of Brush.Z Size of Brush. Signature: ```csharp public int GetCellIndex(int x, int y, int z, int sizex, int sizey, int s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f21d48972223
unity_docs
scripting
What is `Application.backgroundLoadingPriority` in Unity? Explain its purpose and usage.
Application.backgroundLoadingPriority public static ThreadPriority backgroundLoadingPriority ; Description Priority of background loading thread. Lets you control how long it takes to load data asynchronously vs performance impact on the game while loading in the background. Note : This setting has no effect ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3cd59b4047d3
unity_docs
editor
What is `Rendering.GraphicsTier` in Unity? Explain its purpose and usage.
GraphicsTier enumeration Description An enum that represents graphics tiers . Note: Graphics tiers are only supported in the Built-in Render Pipeline. Additional resources: Graphics tiers , TierSettings , Graphics.activeTier , EditorGraphicsSettings.GetTierSettings , EditorGraphicsSettings.SetTierSettings ....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e733374bdcbb_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The View handles user interface and user inputRelates to the Signature: ```csharp public class CustomizeCharacterView: MonoBehaviour, IView ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_5ec38060871e
unity_docs
scripting
In Unity's 'Audio Listener', what is 'Hints' and how does it work?
Each scene can only have one Audio Listener. You access the Project-wide Audio settings using the Audio window (main menu: Edit > Project Settings , then select the Audio category). View the Audio Clip Component page for more information about Mono vs Stereo sounds.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f0a6cb3e71b
unity_docs
rendering
What is `GL.PushMatrix` in Unity? Explain its purpose and usage.
GL.PushMatrix Declaration public static void PushMatrix (); Description Saves the model, view and projection matrices to the top of the matrix stack. Changing the model, view or projection matrices overrides the current rendering matrices. It is good practice to save and restore these matrices using GL.PushMat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80bb98f80f3c
unity_docs
scripting
Show me a Unity C# example demonstrating `Apple.ReplayKit.ReplayKit.StartBroadcasting`.
adcast, you also have to call ShowCameraPreviewAt as well to position the preview view. Description Initiates and starts a new broadcast When StartBroadcast is called, user is presented with a broadcast provider selection screen, and then a broadcast setup screen. Once it is finished, a broadcast will be started, and...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2d5e3dbafea8
unity_docs
rendering
In Unity's 'Introduction to lighting data', what is 'Generating lighting data' and how does it work?
The Editor follows different steps to calculate Enlighten Realtime Global Illumination and Baked Global Illumination. The progress bar displays information about the current process. You can continue working in the Editor while the processes run. The stages of lighting precomputation are listed below: Enlighten Realtim...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e67df1e70014
unity_docs
physics
Explain 'Set up forensic debugging for Unity' in Unity.
Learn how to set up Visual Studio or WinDbg to debug your application or Unity Editor after it discovers an issue or crashes. This type of debugging is called forensic debugging. Occasionally, an application doesn’t crash despite having the debugger attached, or it crashes on a remote device where the debugger isn’t av...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1630eb3f8af2
unity_docs
xr
Show me a Unity code example for 'Scripting API for packages'.
t.Add("com.unity.textmeshpro") installs (or updates to) the latest version of the TextMesh Pro package. Using Client.Add("com.unity.textmeshpro@1.3.0") installs version 1.3.0 of the TextMesh Pro package. The Client.Add method returns an AddRequest instance, which you can use to get the status, any errors, or a Request ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1141a80d6543
unity_docs
rendering
What is `Rendering.ShaderQuality` in Unity? Explain its purpose and usage.
ShaderQuality enumeration Description Shader quality preset. Additional resources: PlatformShaderSettings.standardShaderQuality. Properties Property Description Low Low quality shader preset. Medium Medium quality shader preset. High High quality shader preset.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_3d13c89661d4_doc_8
github
scripting
What does `GetKeyFromIndex` do in this Unity script? Explain its purpose and signature.
Gets the key of the entry at the specified index.Zero-based index of entry in ordered dictionary.The key.If is out of range. Signature: ```csharp public object GetKeyFromIndex(int index) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e2edba8cee4f
unity_docs
scripting
Show me a Unity C# example demonstrating `SceneManagement.SceneManagerAPI`.
SceneManagerAPI class in UnityEngine.SceneManagement / Implemented in: UnityEngine.CoreModule Description Derive from this base class to provide alternative implementations to the C# behavior of specific SceneManager methods. The example provided logs if scene loading is done by index and logs a warning to sw...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b5e4e86c1c08
unity_docs
editor
What are the parameters of `Profiling.Sampler.Get` in Unity?
Returns Sampler Sampler object which represents specific profiler label. Description Returns Sampler object for the specific CPU Profiler label. You can use this function to get a Sampler associated with a built-in or custom label. The name parameter is the same you can see in Hierarchy view of the Profiler Window . If...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_b1597643f1b1
github
scripting
Write a Unity C# script called XR Offset Grab Interactable
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.XR.Interaction.Toolkit; public class XROffsetGrabInteractable : XRGrabInteractable { private Vector3 initialAttachLocalPos; private Quaternion initialAttachLocalRot; // Start is called before the f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e5e5d7901c2
unity_docs
xr
What is `XR.XRDisplaySubsystem.appliedViewportScale` in Unity? Explain its purpose and usage.
XRDisplaySubsystem.appliedViewportScale public float appliedViewportScale ; Description The portion of the allocated display texture used by the active stereo device for the current frame. The scale factor is fetched from the device and can change from frame to frame. If you access this value during gameplay ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_acab73612f4f
unity_docs
ui
Show me a Unity C# example demonstrating `EditorWindow.SendEvent`.
.SendEvent Declaration public bool SendEvent ( Event e ); Description Sends an Event to a window. The SendEvent public function passes a selected Event to a chosen visible window. The Event can be found in the EventType list. In the following scripts SendEventExample looks up the ReceiveEventEx...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1d1fb8966903
unity_docs
ui
In Unity's 'Customize the GUI for your audio plug-in', what is '1. Link your GUI to your audio plug-in' and how does it work?
After Unity loads the native plug-in DLL files and registers the contained audio plug-ins, it searches for corresponding GUI files that match the names of the registered plug-ins. To make sure Unity links your custom GUI to your plug-in: Open your custom GUI class. Make sure your GUI class inherits from IAudioEffectPlu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d4074972682c
unity_docs
audio
In Unity's 'Import audio files into Unity', what is 'Import an audio file via the menu' and how does it work?
To use the menu to add your audio file to Unity: In the menu, select Assets > Import New Asset . Locate and select your audio file. Select Import . Unity imports your audio file into your project as an Audio Clip .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_57c5fd7d8089_doc_2
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Object that is rotated about its Z axis to point at the destination anchor. Signature: ```csharp public GameObject destinationIndicator ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_113ab748fe1d
unity_docs
physics
What is `ControllerColliderHit.moveLength` in Unity? Explain its purpose and usage.
ControllerColliderHit.moveLength public float moveLength ; Description How far the character has travelled until it hit the collider. Note that this can be different from what you pass to CharacterController.Move , because the initial movement vector is decomposed into a set of movements, according to Charact...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f10f5743e65
unity_docs
xr
What is `iOS.OnDemandResources.PreloadAsync` in Unity? Explain its purpose and usage.
OnDemandResources.PreloadAsync Declaration public static iOS.OnDemandResourcesRequest PreloadAsync (string[] tags ); Parameters Parameter Description tags Tags for On Demand Resources that should be included in the request. Returns OnDemandResourcesRequest Object representing ODR request. Descriptio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_42fd568806e7
unity_docs
scripting
What is `Playables.FrameData.frameId` in Unity? Explain its purpose and usage.
FrameData.frameId public ulong frameId ; Description The current frame identifier. The frameId is incremented by 1 for every call to Playable.PrepareFrame and incremented by 2 for every call to PlayableGraph.Evaluate .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b7878744b974
unity_docs
rendering
What is `ShaderUtil.GetCallableShaderCount` in Unity? Explain its purpose and usage.
ShaderUtil.GetCallableShaderCount Declaration public static int GetCallableShaderCount ( Rendering.RayTracingShader s ); Parameters Parameter Description s The RayTracingShader instance. Returns int The number of callable Shaders defined in the RayTracingShader instance passed as argument. Descri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9614fea3f48c
unity_docs
scripting
What is `ArticulationBody.GetPointVelocity` in Unity? Explain its purpose and usage.
ArticulationBody.GetPointVelocity Declaration public Vector3 GetPointVelocity ( Vector3 worldPoint ); Description Gets the velocity of the articulation body at the specified worldPoint in global space. GetPointVelocity takes the angularVelocity of the articulation body into account when calculating the v...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57729d3ab599
unity_docs
rendering
What is `Search.SearchService.CreateIndex` in Unity? Explain its purpose and usage.
SearchService.CreateIndex Declaration public static void CreateIndex (ref string name , ref Search.IndexingOptions options , IEnumerable<string> roots , IEnumerable<string> includes , IEnumerable<string> excludes , Action<string,string,Action> onIndexReady ); Parameters Parameter Description name Uniq...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3738ab045023
unity_docs
math
What is `Mesh.SetVertexBufferParams` in Unity? Explain its purpose and usage.
Mesh.SetVertexBufferParams Declaration public void SetVertexBufferParams (int vertexCount , params VertexAttributeDescriptor[] attributes ); Declaration public void SetVertexBufferParams (int vertexCount , NativeArray<VertexAttributeDescriptor> attributes ); Parameters Parameter Description vertexCoun...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a46138da6fd3
unity_docs
editor
Show me a Unity C# example demonstrating `Search.SearchIndexer.AddNumber`.
ic void AddNumber (string key , double value , int score , int documentIndex ); Parameters Parameter Description key Key used to retrieve the value. value Number value to store in the index. score Relevance score of the word. documentIndex Document where the indexed value was found. Description Adds...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2c5e2c4acc3f
unity_docs
rendering
What is `Rendering.CommandBuffer.BuildRayTracingAccelerationStructure` in Unity? Explain its purpose and usage.
CommandBuffer.BuildRayTracingAccelerationStructure Declaration public void BuildRayTracingAccelerationStructure ( Rendering.RayTracingAccelerationStructure accelerationStructure ); Declaration public void BuildRayTracingAccelerationStructure ( Rendering.RayTracingAccelerationStructure accelerationStructure ,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5152a0bbde88
unity_docs
editor
What is `Editor.CreateEditorWithContext` in Unity? Explain its purpose and usage.
Editor.CreateEditorWithContext Declaration public static Editor CreateEditorWithContext (Object[] targetObjects , Object context , Type editorType = null); Description Make a custom editor for targetObject or targetObjects with a context object. This method is identical to CreateEditor except that...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_bd5969e828d3_doc_14
github
scripting
What does `MoveTo` do in this Unity script? Explain its purpose and signature.
Moves the camera to view the supplied interest point instantaneously, without any animation.Requires that a camera has been set using SetControlledCamera.The latitude and longitude of the point on the ground which the camera should look at.Optional. The distance in metres from the interest point at which the camera sho...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
gh_0d351936d75b_doc_2
github
scripting
What does `ShowStartButton` do in this Unity script? Explain its purpose and signature.
Updates the control UI with the initial state, and when the user completes playback of a eye gaze log file. Signature: ```csharp public void ShowStartButton() ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_133a3230fd7e
unity_docs
animation
What is `AnimatorCullingMode.CullUpdateTransforms` in Unity? Explain its purpose and usage.
AnimatorCullingMode.CullUpdateTransforms Description Retarget, IK and write of Transforms are disabled when renderers are not visible. The statemachine and root motion will always be evaluated. Thus you will always receive the OnAnimatorMove callbacks. All other animation will be skipped if the character is not vis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_45eae08dd7b2
unity_docs
scripting
What is `Rendering.VertexAttributeDescriptor.ctor` in Unity? Explain its purpose and usage.
VertexAttributeDescriptor Constructor Declaration public VertexAttributeDescriptor ( Rendering.VertexAttribute attribute , Rendering.VertexAttributeFormat format , int dimension , int stream ); Parameters Parameter Description attribute The VertexAttribute . format Format of the vertex attribute. De...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3896510ee604
unity_docs
editor
What are the parameters of `EditorGUIUtility.AddCursorRect` in Unity?
Description Add a custom mouse pointer to a control. ```csharp // Create a small window that has a color box in it. // Hovering over it causes a Zoom mouse cursor to appear. (The window is not // zoomed however.) using UnityEngine; using UnityEditor;public class AddCursorRectExample : EditorWindow { [MenuItem("Exa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c1082b24f3e3
unity_docs
performance
What is `UIElements.EventInterestAttribute` in Unity? Explain its purpose and usage.
EventInterestAttribute class in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description Optional attribute on overrides of CallbackEventHandler.HandleEventBubbleUp and CallbackEventHandler.HandleEventTrickleDown . Use this attribute to specify all the event types used by the metho...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80001ee2b9f6
unity_docs
ui
What are the parameters of `GUI.BringWindowToBack` in Unity?
Description Bring a specific window to back of the floating windows. ```csharp // Draws 2 overlapped windows and when clicked on 1 window's button // Brings the window to the back.using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { private Rect windowRect = new Rect(20, 20, 120, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c195a1f0e812
unity_docs
rendering
What is `TextureImporterType` in Unity? Explain its purpose and usage.
TextureImporterType enumeration Description Select this to set basic parameters depending on the purpose of your texture. Properties Property Description Default This is the most common setting used for all the textures in general. NormalMap Select this to turn the color channels into a format suitable for rea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4cec7cd2136
unity_docs
scripting
What is `Events.UnityEventTools.RegisterIntPersistentListener` in Unity? Explain its purpose and usage.
UnityEventTools.RegisterIntPersistentListener Declaration public static void RegisterIntPersistentListener ( Events.UnityEventBase unityEvent , int index , UnityAction<int> call , int argument ); Parameters Parameter Description unityEvent Event to modify. index Index to modify. call Function to call...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_55cda7ae5e98
unity_docs
performance
Explain 'Compressing mesh data for optimization' in Unity.
Techniques and strategies for compressing mesh data in Unity to reduce its size, which can improve performance. Topic Description Types of mesh data compression Understand the difference between mesh compression and vertex compression, and their impact on your project. Configure vertex compression Configure the precisi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_36459a3851f8
unity_docs
scripting
What is `Media.MediaRational.Set` in Unity? Explain its purpose and usage.
MediaRational.Set Declaration public void Set (int numerator , int denominator ); Parameters Parameter Description numerator New value for the rational numerator. denominator New value for the rational denominator. Description Sets the numerator and denominator, performing normalization. Additional res...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c5fbcace6d3
unity_docs
editor
Show me a Unity C# example demonstrating `VersionControl.Provider.GetAssetByPath`.
tByPath (string unityPath ); Parameters Parameter Description unityPath Path to asset. Description Returns the version control information about an asset. Can be used with " AssetList.Add" to add assets to a list for further version control actions. Will return null if the path is not known by the Unity Edit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2dc0f329abdf
unity_docs
xr
What is `Unity.Hierarchy.Hierarchy` in Unity? Explain its purpose and usage.
Hierarchy class in Unity.Hierarchy / Implemented in: UnityEngine.HierarchyCoreModule Description Represents a tree-like container of nodes. Properties Property Description Count The total number of nodes. IsCreated Whether or not this object is valid and uses memory. Root The root node. Upd...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4983b7ae2954
unity_docs
scripting
Show me a Unity C# example demonstrating `Handles.ConeHandleCap`.
. Description Draw a cone handle. Pass this into handle functions. On EventType.Layout event, calculates handle distance to mouse and calls HandleUtility.AddControl accordingly. On EventType.Repaint event, draws the handle shape. Cone Handle Cap in the Scene View. Add the following script to your Assets folde...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d35333d1dcce_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Specifies what should happen when the GameObject is re-enabled:'Push' means that the event callback will be instantly called with the current value Signature: ```csharp protected enum Resume ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_af0e3e5344c9
unity_docs
audio
What is `Experimental.Audio.AudioSampleProvider.Dispose` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. AudioSampleProvider.Dispose Declaration public void Dispose (); Description Release internal resources. Inherited from IDisposable.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d912c6ac36da
unity_docs
rendering
Give me an overview of the `TextureImporterFormat` class in Unity.
TextureImporterFormat enumeration Description Imported texture format for TextureImporter . Most of the values match the ones in TextureFormat , with addition of the "Automatic" ones that pick the best format based on platform and texture type or usage. Additional resources: TextureImporter.textureFormat. Prope...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_129e8916c447
unity_docs
physics
Show me a Unity C# example demonstrating `Rigidbody.inertiaTensor`.
otational Constraints RigidbodyConstraints of Rigidbody are actually implemented by setting the inertia tensor components about the locked degrees of freedom to zero. If you don't set the inertia tensor from a script, it is calculated automatically from all colliders attached to the Rigidbody. To reset the inertia te...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_33bd916052c8
unity_docs
xr
What is `RenderTexture.ReleaseTemporary` in Unity? Explain its purpose and usage.
RenderTexture.ReleaseTemporary Declaration public static void ReleaseTemporary ( RenderTexture temp ); Description Release a temporary texture allocated with GetTemporary . Later calls to GetTemporary will reuse the RenderTexture created earlier if possible. When no one has requested the temporary RenderT...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f8214e4cb436
unity_docs
audio
What is `AudioImporter.ContainsSampleSettingsOverride` in Unity? Explain its purpose and usage.
AudioImporter.ContainsSampleSettingsOverride Declaration public bool ContainsSampleSettingsOverride ( BuildTargetGroup platformGroup ); Declaration public bool ContainsSampleSettingsOverride (string platform ); Parameters Parameter Description platformGroup The platform for which to query if this Audio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78c1c726c7d7
unity_docs
editor
What is `DialogOptOutDecisionType` in Unity? Explain its purpose and usage.
DialogOptOutDecisionType enumeration Description The type of opt-out decision a user can make. This enum is used with EditorUtility.DisplayDialog and specifies the nature of the opt-out decision Unity presents to the user. It stores the user's decision on how long they would like to opt out for: either just for ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_055c100cd402
unity_docs
rendering
Explain 'Light Probe data format' in Unity.
The lighting information in the light probes are encoded as Spherical Harmonics basis functions. We use third order polynomials, also known as L2 Spherical Harmonics. These are stored using 27 floating point values, 9 for each color channel. The Enlighten Realtime Global Illumination implementation in Unity uses a diff...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b525a74a5b7b
unity_docs
input
In Unity's 'Enable optional features for Embedded Linux', what is 'Shader cache persistence for GLES3' and how does it work?
Embedded Linux supports binary shader caching on the device where the Unity Player is installed for better startup timings. The cache is created at runtime after you load a shader. As this cache is written to the temporary folder: [TEMP]/[COMPANY_NAME]/[PROJECT_NAME]/UnityShaderCache/ , it can be wiped when you restart...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b187740fbb91
unity_docs
rendering
Show me a Unity C# example demonstrating `LightTransport.BakeProgressState.IncrementCompletedWorkSteps`.
the amount of completed work steps for this progress state. Updates the progress by adding the specified number of completed work steps. This method is typically called by the implementation during operation execution to report incremental progress. The progress percentage is calculated as: completedSteps / totalSteps...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_517925e1ba58
unity_docs
scripting
What is `Experimental.GraphView.Attacher.distance` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Attacher.distance public float distance ; Description The distance between the attached element and the target.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1dded27fe124
unity_docs
scripting
What is `QualitySettings.realtimeReflectionProbes` in Unity? Explain its purpose and usage.
QualitySettings.realtimeReflectionProbes public static bool realtimeReflectionProbes ; Description Enables or disables real-time reflection probes. If disabled, real-time reflection probes will not be baked. Additional resources: Quality Settings .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d1624418ec18
github
scripting
Write a Unity C# UI script for Benchmark03
```csharp using UnityEngine; using System.Collections; using UnityEngine.TextCore.LowLevel; namespace TMPro.Examples { public class Benchmark03 : MonoBehaviour { public enum BenchmarkType { TMP_SDF_MOBILE = 0, TMP_SDF__MOBILE_SSD = 1, TMP_SDF = 2, TMP_BITMAP_MOBILE = 3, TEXTMESH_BITMAP = 4 } ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_c76de78ae87a
unity_docs
performance
Explain 'Optimize the Particle System with the C# Job System' in Unity.
A Particle System can use Unity’s C# Job System to apply custom behaviors to particles. Unity distributes work from the C# Job System across worker threads, and can make use of the Burst Compiler. The GetParticles() and SetParticles() methods offer similar functionality, but run on the main thread and cannot make use o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7674745046b0
unity_docs
scripting
What is `Search.SearchItem.ctor` in Unity? Explain its purpose and usage.
SearchItem Constructor Declaration public SearchItem (string _id ); Parameters Parameter Description _id Unique ID of the SearchItem. Description Construct a search item. A search item needs to have at least a unique ID for a given search query. SearchItem are generally created using the SearchProvider.C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_058681d280ef
unity_docs
editor
What is `Rendering.EditorGraphicsSettings.GetRenderPipelineSettingsFromInterface` in Unity? Explain its purpose and usage.
EditorGraphicsSettings.GetRenderPipelineSettingsFromInterface Declaration public static TSettingsInterfaceType[] GetRenderPipelineSettingsFromInterface (); Returns TSettingsInterfaceType[] Returns an array of settings of type TSettingsInterfaceType . If none were found, the array is empty. Description Get...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8f379ed95874
unity_docs
scripting
What is `PrefabUtility.PrefabInstanceUpdated` in Unity? Explain its purpose and usage.
PrefabUtility.PrefabInstanceUpdated Declaration public delegate void PrefabInstanceUpdated ( GameObject instance ); Description Delegate for method that is called after Prefab instances in the Scene have been updated.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ee63dead9e4
unity_docs
physics
What is `PhysicsVisualizationSettings.SetShowForAllFilters` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.SetShowForAllFilters Declaration public static void SetShowForAllFilters (bool selected ); Obsolete Enum PhysicsVisualizationSettings.FilterWorkflow has been deprecated. Use APIs without this argument instead. Declaration public static void SetShowForAllFilters ( PhysicsVisualiza...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f8f5ed325df2
unity_docs
math
What is `IMGUI.Controls.SphereBoundsHandle.radius` in Unity? Explain its purpose and usage.
SphereBoundsHandle.radius public float radius ; Description Returns or specifies the radius of the sphere bounding volume. A negative value will automatically be converted into a positive value. If only a single axis is enabled, the value will automatically be converted to 0 . Additional resources: Primitive...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_24699539d945
unity_docs
editor
Show me a Unity C# example demonstrating `AssetModificationProcessor.MakeEditable`.
eration needs to be done. If null (default), no prompt is shown. outNotEditablePaths Output list of file paths that could not be made editable. Returns void Returns true if all files have been made editable. Description Unity calls this method when one or more files need to be opened for editing. It must...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bea41fbdd2be
unity_docs
scripting
What is `Search.SearchUtils.GetHierarchyPath` in Unity? Explain its purpose and usage.
SearchUtils.GetHierarchyPath Declaration public static string GetHierarchyPath ( GameObject gameObject , bool includeScene ); Parameters Parameter Description gameObject GameObject to extract a path from. includeScene If true, will append the scene name to the path. Returns string Returns the path of...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e98e8412b764
unity_docs
input
Explain 'Support touch input for QNX' in Unity.
The Unity QNX Player supports input via touch devices. To enable this, make sure you meet the following prerequisites and operating system configuration requirements. ## Configure QNX touch scaling As the QNX Unity player requires the touch coordinates to be in screen coordinates, configure the following setup in the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db70515790e0
unity_docs
scripting
What is `MeshUtility.Optimize` in Unity? Explain its purpose and usage.
MeshUtility.Optimize Declaration public static void Optimize ( Mesh mesh ); Description Optimizes the Mesh data to improve rendering performance. This function causes the geometry and vertices of the mesh to be reordered internally in an attempt to improve vertex cache utilisation on the graphics hardware and...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a32ae2ecb8fc
unity_docs
audio
Show me a Unity C# example demonstrating `AudioHighPassFilter.highpassResonanceQ`.
AudioHighPassFilter.highpassResonanceQ public float highpassResonanceQ ; Description Determines how much the filter's self-resonance isdampened. Higher Highpass resonance Q indicates a lower rate of energy loss i.e. the oscillations die out more slowly. Highpass resonance Q value goes from 1.0 to 10.0. Default...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ed833bd8d6eb
unity_docs
scripting
Explain 'Disable a built-in package' in Unity.
You can disable a Built-in package if you don’t need some modules and you want to save resources. However, when you disable a built-in package, the corresponding Unity functionality is no longer available. Disabling a built-in package results in the following: If you use a Scripting API implemented by a disabled packag...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4a6b225cd361
unity_docs
rendering
What is `MaterialPropertyBlock.HasInteger` in Unity? Explain its purpose and usage.
MaterialPropertyBlock.HasInteger Declaration public bool HasInteger (string name ); Declaration public bool HasInteger (int nameID ); Parameters Parameter Description name The name of the property. nameID The name ID of the property. Use Shader.PropertyToID to get this ID. Returns bool Returns t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_ca5112631a9a
github
scripting
Write a Unity C# script called Plugin
```csharp using System; using System.Reflection; using shadcnui_Demo.Menu; using UnityEngine; #if IL2CPP_BEPINEX using BepInEx.Unity.IL2CPP; using BepInEx; using BepInEx.Logging; #elif BEPINEX using BepInEx; using BepInEx.Logging; #elif MELONLOADER using MelonLoader; #endif namespace shadcnui_Demo { // Embed the U...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_69cab45b523a
unity_docs
ui
What is `UIElements.ToggleButtonGroupState.ToEnumFlags` in Unity? Explain its purpose and usage.
ToggleButtonGroupState.ToEnumFlags Declaration public static T ToEnumFlags ( UIElements.ToggleButtonGroupState options , bool acceptsLengthMismatch ); Parameters Parameter Description options The option set to be synced against. acceptsLengthMismatch The ability to synchronize two option sets of differen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f1652af7597f
github
scripting
Write a Unity C# script called Lerp Float
```csharp using System; using Solid.Core; using UnityEngine; /*Copyright (c) Created by Oleksii Volovich 2021*/ namespace Solid.Examples { public sealed class LerpFloat : Awaitable<float> { public event Action Changed; [SerializeField] private float StartValue; [SerializeField...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.