id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_man_66581e0fc70f
unity_docs
editor
In Unity's 'Set background images', what is 'Set the scale mode for a background image' and how does it work?
Scale mode for a background image defines how the image scales to fit the visual element . The supported scale modes for a background image. A: stretch-to-fill that stretches the image to fill the entire area of the visual element. B: scale-and-crop that scales the image to fit the visual element. If the image is large...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3a8a2d66f91f
unity_docs
input
What are the parameters of `GUI.Label` in Unity?
Description Make a text or texture label on screen. Labels have no user interaction, do not catch mouse clicks and are always rendered in normal style. If you want to make a control that responds visually to user input, use a Box control. Example: Draw the classic Hello World! string: Text label on the Game View. ```cs...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4c649aa4099
unity_docs
scripting
Show me a Unity C# example demonstrating `SystemInfo.maxGraphicsBufferSize`.
SystemInfo.maxGraphicsBufferSize public static long maxGraphicsBufferSize ; Description The maximum size of a graphics buffer ( GraphicsBuffer , ComputeBuffer , vertex/index buffer, etc.) in bytes (Read Only). Any GPU buffer ( GraphicsBuffer , ComputeBuffer or a vertex/index buffer used by a Mesh ) can not ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_880105ae8a1f
unity_docs
input
Show me a Unity C# example demonstrating `Cursor.lockState`.
operating system or the Editor. For example, check the state of the cursor when the application regains focus or the state of a game changes to reveal a UI. In the Editor, the cursor loses focus in Game mode when you press Escape or when you switch an application. In the Standalone Player, you have full control over th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f748f1aaa344
unity_docs
performance
Show me a Unity C# example demonstrating `Profiling.Profiler.GetTotalReservedMemoryLong`.
blic static long GetTotalReservedMemoryLong (); Returns long Memory reserved by Unity in bytes. This returns 0 if the Profiler is not available. Description The total memory Unity has reserved. This function returns the total memory Unity has reserved for current and future allocations. If the reserved memo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a8b10cbc804
unity_docs
editor
Show me a Unity C# example demonstrating `Overlays.ToolbarOverlay`.
or.Toolbars.EditorToolbarElement. In this way it is very simple to reuse elements to create customized toolbars. Toolbar overlays require specific styling, so in most cases it is preferable to inherit one of the predefined EditorToolbar types when creating Visual Elements. If custom UI is required, it is valid to inher...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3f68db2ea0b6
unity_docs
editor
What is `QualitySettings.GetActiveQualityLevelsForPlatformCount` in Unity? Explain its purpose and usage.
QualitySettings.GetActiveQualityLevelsForPlatformCount Declaration public static int GetActiveQualityLevelsForPlatformCount (string buildTargetGroupName ); Parameters Parameter Description buildTargetGroupName The platform to obtain the number of selected Quality Levels. Returns int The total amount of ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_17403597d72e
unity_docs
rendering
In Unity's 'Use search providers', what is 'Search with all active providers at once' and how does it work?
By default, a search includes results from four providers: Project: Searches the project’s assets. Hierarchy: Searches GameObjects in the loaded scenes (a loaded scene is displayed in the Hierarchy window). Menu: Search the Unity Editor main menu. Settings: Search all Unity Editor settings. You can add and remove provi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ff550dc79d67
unity_docs
scripting
What is `Font.material` in Unity? Explain its purpose and usage.
Font.material public Material material ; Description The material used for the font display. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Swap 3D Text font color each second // Add this script to a text mesh object bool flag = false; float rate = 1f; TextMesh t; void Update() { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3f576a4d3eca
unity_docs
rendering
Show me a Unity code example for 'Color gradients'.
ly color gradient presets To apply a color gradient preset to text, reference the color gradient by name as <gradient="name-of-the-color-gradient">Your text</gradient> . If you apply the color gradient like this, the color of the text is multiplied by the object’s current vertex colors. To apply the pure gradient to a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0885f2addc65
unity_docs
animation
Show me a Unity C# example demonstrating `HumanTrait.RequiredBone`.
HumanTrait.RequiredBone Declaration public static bool RequiredBone (int i ); Parameters Parameter Description i Index of the bone to test. Description Is the bone a member of the minimal set of bones that Mecanim requires for a human model? The indexing order of the bones is the same as that used for the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_abd8f05786b4
unity_docs
rendering
What is `Editor.OnPreviewSettings` in Unity? Explain its purpose and usage.
Editor.OnPreviewSettings Declaration public void OnPreviewSettings (); Description Override this method if you want to show custom controls in the preview header. The default implementation is a no-op. Note: Inspector previews are limited to the primary editor of persistent objects (assets), e.g., GameObjectIn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_467e24df8e47
unity_docs
editor
What are the parameters of `Search.ISearchView.SetSelection` in Unity?
Description Updates the search view with a new selection. . ```csharp using UnityEditor; using UnityEditor.Search; static class Example_ISearchView_SetSelection { static ISearchView s_View; [MenuItem("Examples/ISearchView/SetSelection")] public static void Run() { s_View = SearchService.ShowCon...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d1de5bcf1cc3
unity_docs
math
What is `Rendering.ResourcePathsAttribute.ctor` in Unity? Explain its purpose and usage.
ResourcePathsAttribute Constructor Declaration public ResourcePathsAttribute (string[] paths , Rendering.SearchType location ); Parameters Parameter Description paths Paths targetting the resources location The lookup method Description Creates a new ResourcePathsAttribute for an array's elements by s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b2e86915e7ec
unity_docs
math
What is `Unity.Collections.Allocator.Domain` in Unity? Explain its purpose and usage.
Allocator.Domain Description Use an allocation associated with the lifetime of a domain. You don't need to free this memory, because Unity frees it automatically at domain unload. However, to conserve memory, you can free it at any time. Freeing a large number of such allocations in one frame, such that the array ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de95bd4dd520
unity_docs
input
What is `Input.touchSupported` in Unity? Explain its purpose and usage.
Input.touchSupported public static bool touchSupported ; Description Returns whether the device on which application is currently running supports touch input. Note : This API is part of the legacy Input Manager. The recommended best practice is that you don't use this API in new projects. For new projects, use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_23d5b5a427a2
unity_docs
rendering
Show me a Unity C# example demonstrating `Rendering.RenderPipeline.EndCameraRendering`.
er Pipeline (HDRP), Unity calls this method automatically after performing rendering operations for an individual Camera. If you are writing a custom Scriptable Render Pipeline, you can call this method manually to use the RenderPipelineManager.endCameraRendering delegate. The following code example demonstrates wher...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b4cba6e66182
unity_docs
scripting
What is `ParticleSystemEmitterVelocityMode` in Unity? Explain its purpose and usage.
ParticleSystemEmitterVelocityMode enumeration Description Control how a Particle System calculates its velocity. Properties Property Description Transform Calculate the Particle System velocity by using the Transform component. Rigidbody Calculate the Particle System velocity by using a Rigidbody or Rigidbody2...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_76eca7198d8b
unity_docs
rendering
What is `XR.XRDisplaySubsystem.GetCullingParameters` in Unity? Explain its purpose and usage.
XRDisplaySubsystem.GetCullingParameters Declaration public void GetCullingParameters ( Camera camera , int cullingPassIndex , out Rendering.ScriptableCullingParameters scriptableCullingParameters ); Parameters Parameter Description camera Camera for the basis of the culling view and frustum. cullingPa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_04619da0ee80
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.LimitVelocityOverLifetimeModule.limitY`.
ParticleSystem.LimitVelocityOverLifetimeModule.limitY public ParticleSystem.MinMaxCurve limitY ; Description Maximum velocity curve for the y-axis. Additional resources: MinMaxCurve . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_587f50a7ed55
unity_docs
rendering
What is `TerrainTools.OnInspectorGUIContext.ShowBrushesGUI` in Unity? Explain its purpose and usage.
OnInspectorGUIContext.ShowBrushesGUI Declaration public void ShowBrushesGUI (int spacing , TerrainTools.BrushGUIEditFlags flags , int textureResolutionPerTile ); Parameters Parameter Description spacing Indicate how much spacing to use in the GUILayout. flags Indicates which brush attributes to display...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_941c311d3b1e
unity_docs
math
What is `Mathf.Infinity` in Unity? Explain its purpose and usage.
Mathf.Infinity public static float Infinity ; Description A representation of positive infinity (Read Only). ```csharp using UnityEngine;public class Example : MonoBehaviour { // Casts a ray from (0,0,0) towards (0,0,1) to the infinity and prints a message // if any object has touched the ray. // To test it...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_99ed0b0c0f06
unity_docs
rendering
In Unity's 'Properties block reference in ShaderLab', what is 'Render pipeline compatibility' and how does it work?
Feature name Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Custom SRP Built-in Render Pipeline ShaderLab: Properties block Yes In your HLSL code, you must put per-material variables in the same CBUFFER for SRP Batcher compatibility. Yes In your HLSL code, you must put per-material variables in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_76a522318821
unity_docs
editor
Show me a Unity C# example demonstrating `PlayerSettings.productName`.
PlayerSettings.productName public static string productName ; Description The name of your product. This will appear on the menu bar when your game is running and is used to locate the preferences file. Custom player settings. ```csharp using UnityEngine; using UnityEditor; // Simple Script that saves and lo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0294d6e43a85
unity_docs
rendering
What are the parameters of `Cubemap.ctor` in Unity?
Description Create a new empty cubemap texture. The texture will be size on each side and can be created with or without mipmaps. Enable createUninitialized to make the texture reference uninitialized data (both on the CPU and GPU). When overriding all texels, this can lead to improved performance and reduced memory us...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_391d769a9c0d
unity_docs
scripting
Show me a Unity C# example demonstrating `CollisionFlags`.
CollisionFlags enumeration Description CollisionFlags is a bitmask returned by CharacterController.Move. It gives you a broad overview of where your character collided with any other objects. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Update() { Chara...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_de0ce2f8ba92
unity_docs
physics
Show me a Unity code example for 'Troubleshoot D3D12 GPU crashes on Windows'.
during standard game logic. Graphics API calls : The stack trace mentions the graphics API layer, such as D3D12Fence::Wait . Device error codes : The log contains errors like Device failed error (887a0006) or Device removal . GPU memory status : The log might indicate the memory status, for example: d3d12: GfxDevice wa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8ed449d68cf5
unity_docs
physics
Give me an overview of the `FontRenderingMode` class in Unity.
FontRenderingMode enumeration Description Font rendering mode constants for TrueTypeFontImporter. Properties Property Description Smooth Use Anti-Aliased Font rendering. When using dynamic fonts, this is the mode which is fastest in rendering font textures. HintedSmooth Use Anti-Aliased Font rendering with hin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b90973a0694f
unity_docs
scripting
Give me an overview of the `ApiCompatibilityLevel` class in Unity.
ApiCompatibilityLevel enumeration Description .NET API compatibility level. Properties Property Description NET_2_0.NET 2.0. NET_2_0_Subset.NET 2.0 Subset. NET_4_6 Deprecated, use ApiCompatibilityLevel.NET_Unity_4_8 instead. NET_Web Web profile, formerly used only by Samsung TV. NET_Micro Micro profile, use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eb11dc24c8b8
unity_docs
scripting
What is `SerializedPropertyType.ManagedReference` in Unity? Explain its purpose and usage.
SerializedPropertyType.ManagedReference Description Represents a property that references an object that does not derive from UnityEngine.Object. This type is for fields that have the SerializeReference attribute, otherwise the object is stored inline ( SerializedPropertyType.Generic ). Additional resources: Se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af1329219428
unity_docs
rendering
What is `LightingSettings.filteringGaussianRadiusIndirect` in Unity? Explain its purpose and usage.
LightingSettings.filteringGaussianRadiusIndirect public float filteringGaussianRadiusIndirect ; Description Specifies the method that the Progressive Lightmapper uses to reduce noise in lightmaps. (Editor only). Options are None , Automatic , or Advanced . This setting affects lightmaps generated by the B...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d3bcd60dc2d8
unity_docs
rendering
What is `iOS.iOSPlatformIconKind` in Unity? Explain its purpose and usage.
iOSPlatformIconKind class in UnityEditor.iOS Description Contains all iOS PlatformIconKind supported by Unity. More detailed information on iOS icons can be found in the iOS icon design guidelines . Static Properties Property Description Application This is the icon displayed on the iOS home screen. Mark...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3b27371c0de8
unity_docs
rendering
Show me a Unity C# example demonstrating `SpriteRenderer`.
SpriteRenderer class in UnityEngine / Inherits from: Renderer / Implemented in: UnityEngine.CoreModule Description Renders a Sprite for 2D graphics. ```csharp //This example outputs Sliders that control the red green and blue elements of a sprite's color //Attach this to a GameObject and attach a SpriteRender...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9b5304766a34
unity_docs
animation
What is `Animations.LookAtConstraint.locked` in Unity? Explain its purpose and usage.
LookAtConstraint.locked public bool locked ; Description Locks the offset and rotation at rest. In Edit mode, unlocks the constraint to update its offsets. In Play mode, the constraint is always locked.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_677bbaa82ee6
github
scripting
Write a Unity C# MonoBehaviour script called Helper
```csharp using System; using System.Collections.Generic; using System.Linq; using System.Reflection; using UnityEngine; using Object = UnityEngine.Object; namespace DebugMenu { internal static class Helper { public static readonly Dictionary<Type, string> TypeAliases = new Dictionary<Type, string> ...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_4f80f86615c7
unity_docs
editor
Show me a Unity C# example demonstrating `Search.SearchIndexer.AddDocument`.
the document. source Source of the document. In example, if the document is a nested object, the source should be the container asset path. checkIfExists Pass true if this document has some chance of existing already. flags Flags describing the nature of the document. Returns int The document index/handle use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_36a1a017057e
unity_docs
rendering
What is `Mesh.CombineMeshes` in Unity? Explain its purpose and usage.
Mesh.CombineMeshes Declaration public void CombineMeshes (CombineInstance[] combine , bool mergeSubMeshes = true, bool useMatrices = true, bool hasLightmapData = false); Parameters Parameter Description combine Descriptions of the Meshes to combine. mergeSubMeshes Defines whether Meshes should be co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bce01b5b27fc
unity_docs
editor
What are the parameters of `EditorGUI.PropertyField` in Unity?
Returns bool True if the property has children and is expanded and includeChildren was set to false; otherwise false. Description Use this to make a field for a SerializedProperty in the Editor. Additional resources: SerializedProperty , SerializedObject . ```csharp //Attach a script like this to the GameObject you wou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49ac1756506f
unity_docs
scripting
What is `Time.fixedTimeAsDouble` in Unity? Explain its purpose and usage.
Time.fixedTimeAsDouble public static double fixedTimeAsDouble ; Description The double precision time since the last FixedUpdate started (Read Only). This is the time in seconds since the start of the game. Fixed time is updated in regular intervals (equal to fixedDeltaTime ) until the timeAsDouble propert...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab9348c9b778
unity_docs
rendering
What is `Rendering.ShaderCompilerData.graphicsTier` in Unity? Explain its purpose and usage.
ShaderCompilerData.graphicsTier public Rendering.GraphicsTier graphicsTier ; Description A GraphicsTier classifies low, medium and high performance hardware. You can only set a Graphics Tier in the Built-in Render Pipeline.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0cd2c87e2fdb
unity_docs
editor
What is `EditorGUILayout.DelayedFloatField` in Unity? Explain its purpose and usage.
EditorGUILayout.DelayedFloatField Declaration public static float DelayedFloatField (float value , params GUILayoutOption[] options ); Declaration public static float DelayedFloatField (float value , GUIStyle style , params GUILayoutOption[] options ); Declaration public static float DelayedFloatField...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_da3fb1740d72
unity_docs
scripting
What is `Windows.Speech.DictationTopicConstraint` in Unity? Explain its purpose and usage.
DictationTopicConstraint enumeration Description DictationTopicConstraint enum specifies the scenario for which a specific dictation recognizer should optimize. Properties Property Description WebSearch Dictation recognizer will optimize for web search scenario. Form Dictation recognizer will optimize for form...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e3a51a8fc854
unity_docs
scripting
What is `GraphicsBuffer.usageFlags` in Unity? Explain its purpose and usage.
GraphicsBuffer.usageFlags public GraphicsBuffer.UsageFlags usageFlags ; Description The flags that specify how this GraphicsBuffer can be used or updated (Read Only). Additional resources: UsageFlags .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_afd250c6f343
unity_docs
xr
What is `CustomRenderTextureUpdateZone.needSwap` in Unity? Explain its purpose and usage.
CustomRenderTextureUpdateZone.needSwap public bool needSwap ; Description If true, and if the texture is double buffered, a request is made to swap the buffers before the next update. Otherwise, the buffers will not be swapped. Additional resources: CustomRenderTexture .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ef22b8efa005
unity_docs
scripting
What is `UIElements.Repeat` in Unity? Explain its purpose and usage.
Repeat enumeration Description Defines how the background is repeated. Properties Property Description NoRepeat The background-image isn't repeated. The image is only shown once. This is the default to keep background compatibility with unity-background-scale-mode. Space The background-image is repe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bde0987ffd2b
unity_docs
editor
Show me a Unity C# example demonstrating `Profiling.FrameDataView.GfxResourceInfo`.
GfxResourceInfo struct in UnityEditor.Profiling Description Provides methods for retrieving graphics resource information. ```csharp using UnityEditorInternal; using UnityEditor.Profiling;public class Example { public static string GetGfxResourceName(int frame, ulong gfxResourceId) { using (var frameData = Pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c0f1dd1d6283
unity_docs
scripting
What is `Experimental.GraphView.StickyNote.BuildContextualMenu` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. StickyNote.BuildContextualMenu Declaration public void BuildContextualMenu ( UIElements.ContextualMenuPopulateEvent evt ); Description Builds the [StickyNote] contextual menu.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ba3b8d65e30
unity_docs
editor
What is `Rendering.RenderPipelineAsset.terrainBrushPassIndex` in Unity? Explain its purpose and usage.
RenderPipelineAsset.terrainBrushPassIndex public int terrainBrushPassIndex ; Returns int Queue index. Description The render index for the terrain brush in the editor. When rendering terrain the brush used is rendered at a specific queue, this indicates the queue that should be used in the given render pi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_836f59dbf1db
unity_docs
animation
Show me a Unity C# example demonstrating `AnimationState.enabled`.
AnimationState.enabled public bool enabled ; Description Enables / disables the animation. For the animation to take any effect the weight also needs to be set to a value higher than zero. If the animation is disabled, time will be paused until the animation is enabled again. ```csharp using UnityEngine; using...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e69ce12b0e05
unity_docs
scripting
In Unity's 'Bind ListView to a list with runtime binding', what is 'Example overview' and how does it work?
This example creates a GameSwitchListAsset ScriptableObject that contains a list of GameSwitch objects. Each GameSwitch object has two properties: enabled and name . The ListView displays a list of toggles and text fields that are bound to the enabled and name properties of each GameSwitch object. You can find the comp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc96274b9d0b
unity_docs
xr
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerRequestMetric.TimeInQueueMicroseconds` in Unity? Explain its purpose and usage.
AsyncReadManagerRequestMetric.TimeInQueueMicroseconds public double TimeInQueueMicroseconds ; Description The amount of time the read request waited in the AsyncReadManager queue, in microseconds. For read requests that were actively reading or had already finished when this metrics record was created, the time...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_964f4131d6db
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.IsCacheServerEnabled`.
AssetDatabase.IsCacheServerEnabled Declaration public static bool IsCacheServerEnabled (); Returns bool Returns true when the Cache Server is enabled. Returns false otherwise. Description Checks whether the Cache Server is enabled in Project Settings. ```csharp using UnityEngine; using UnityEditor;public ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e5da98f45f6d
unity_docs
rendering
What is `MaterialPropertyDrawer.OnGUI` in Unity? Explain its purpose and usage.
MaterialPropertyDrawer.OnGUI Declaration public void OnGUI ( Rect position , MaterialProperty prop , string label , MaterialEditor editor ); Parameters Parameter Description position Rectangle on the screen to use for the property GUI. prop The MaterialProperty to make the custom GUI for. label ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c297607aa516
github
scripting
Write a Unity C# MonoBehaviour script called Web RTC Client
```csharp using UnityEngine; namespace TapLive.Network { /// <summary> /// WebRTC client for peer-to-peer video/audio streaming /// NOTE: This is a stub - requires Unity WebRTC package or external library /// Install via: Package Manager > Add package from git URL > com.unity.webrtc /// </summary> ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_e01000650dfe
unity_docs
editor
What is `TerrainTools.IOnPaint.Repaint` in Unity? Explain its purpose and usage.
IOnPaint.Repaint Declaration public void Repaint ( TerrainTools.RepaintFlags flags ); Parameters Parameter Description flags Specifies what to repaint. Description Instructs the Editor to repaint the tool UI, the Scene view, or both.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e4ba4352a3db
unity_docs
math
Show me a Unity C# example demonstrating `Animator.rightFeetBottomHeight`.
Animator.rightFeetBottomHeight public float rightFeetBottomHeight ; Description Get right foot bottom height. ```csharp using UnityEngine;public class Example : MonoBehaviour { Animator animator; void Start() { animator = GetComponent<Animator>(); } void LateUpdate() { if (animator) { Vector3 rightFoot...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4171b2afc9d3
unity_docs
editor
What is `Profiling.FrameDataView.GetUnityObjectNativeTypeInfo` in Unity? Explain its purpose and usage.
FrameDataView.GetUnityObjectNativeTypeInfo Declaration public bool GetUnityObjectNativeTypeInfo (int nativeTypeIndex , out Profiling.FrameDataView.UnityObjectNativeTypeInfo info ); Parameters Parameter Description nativeTypeIndex Native type index. info Native type information output struct with name an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b5abbd3b15ee
unity_docs
scripting
What is `ComputeShaderImporter` in Unity? Explain its purpose and usage.
ComputeShaderImporter class in UnityEditor / Inherits from: AssetImporter Description Define compute shader import settings in the Unity Editor. Properties Property Description preprocessorOverride This property has no effect. Inherited Members Properties Property Description assetBundleName Get or set t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a470377a24c8
unity_docs
rendering
What is `ModelImporterMaterialLocation.InPrefab` in Unity? Explain its purpose and usage.
ModelImporterMaterialLocation.InPrefab Description Unity imports materials as sub-assets. Materials imported as sub-assets are read-only and can only be modified after they are extracted. When using this setting, Unity does not extract the embedded textures during import. Additional resources: ModelImporter.Search...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2e388637a30e
unity_docs
rendering
In Unity's 'Customize the global cache', what is 'Important notes before you begin' and how does it work?
Regardless of the method you choose, changing the cache location tells the Package Manager to use that location going forward. Existing packages that Package Manager stored in the original location remain in that folder structure. If you set the maximum size of the db subdirectory and the new size is less than the curr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3325ab87cc97
unity_docs
rendering
What is `AssetDatabase.RenameAsset` in Unity? Explain its purpose and usage.
AssetDatabase.RenameAsset Declaration public static string RenameAsset (string pathName , string newName ); Parameters Parameter Description pathName The path where the asset currently resides. newName The new name which should be given to the asset. Returns string An empty string, if the asset has be...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4038f17dd68b
github
scripting
Write a Unity C# script called Property Changed Event
```csharp using UnityEngine.Events; namespace RMC.Core.Architectures.Umvcs.Controller.Events { /// <summary> /// Holds the before and after value during a property chagnge /// </summary> public abstract class PropertyChangedEvent<T> : UnityEvent<T,T>, IEvent { } } ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_80f9eb0c968d
unity_docs
scripting
What is `Camera.ScreenPointToRay` in Unity? Explain its purpose and usage.
Camera.ScreenPointToRay Declaration public Ray ScreenPointToRay ( Vector3 pos ); Declaration public Ray ScreenPointToRay ( Vector3 pos , Camera.MonoOrStereoscopicEye eye ); Parameters Parameter Description pos A 3D point, with the x and y coordinates containing a 2D screen space point in pixel...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3986395a5b69
unity_docs
editor
What is `MeshUtility.AcquireReadOnlyMeshData` in Unity? Explain its purpose and usage.
MeshUtility.AcquireReadOnlyMeshData Declaration public static Mesh.MeshDataArray AcquireReadOnlyMeshData ( Mesh mesh ); Declaration public static Mesh.MeshDataArray AcquireReadOnlyMeshData (Mesh[] meshes ); Declaration public static Mesh.MeshDataArray AcquireReadOnlyMeshData (List<Mesh> meshes ); ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_550dbb706677
unity_docs
editor
What is `Unity.CodeEditor.CodeEditor.Editor` in Unity? Explain its purpose and usage.
CodeEditor.Editor public static Unity.CodeEditor.CodeEditor Editor ; Description A singleton instance of CodeEditor . The Unity Editor references this instance to handle code editor callbacks.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49f2be194dbc
unity_docs
networking
What is `Networking.PlayerConnection.EditorConnection.TrySend` in Unity? Explain its purpose and usage.
EditorConnection.TrySend Declaration public bool TrySend (Guid messageId , byte[] data , int playerId ); Declaration public bool TrySend (Guid messageId , byte[] data ); Parameters Parameter Description messageId The type ID of the message to send to the connected Players. playerId The ID of the Pl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_319d84d71795
unity_docs
rendering
What is `ModelImporterMaterialImportMode.ImportViaMaterialDescription` in Unity? Explain its purpose and usage.
ModelImporterMaterialImportMode.ImportViaMaterialDescription Description The model importer creates materials using the PreprocessMaterialDescription AssetPostprocessor. When selected, the model importer delegates the process of populating new material properties to OnPreprocessMaterialDescription AssetPostprocesso...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b487bc85f58d
unity_docs
scripting
Explain 'Asynchronous programming with the Awaitable class' in Unity.
Asynchronous programming allows your code to perform long-running tasks without blocking the main thread. This allows your application to remain responsive and perform other tasks while it waits for an asynchronous task to complete. Unity supports a simplified asynchronous programming model using the .NET async key wor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8d62438c7d7c
unity_docs
rendering
What is `Gyroscope` in Unity? Explain its purpose and usage.
Gyroscope class in UnityEngine / Implemented in: UnityEngine.InputLegacyModule Description Interface into the Gyroscope. Use this class to access the gyroscope. The example script below shows how the Gyroscope class can be used to view the orientation in space of the device. Underlying sensors used for data pop...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cb2c99eb07bf
unity_docs
scripting
What is `Vector2.ctor` in Unity? Explain its purpose and usage.
Vector2 Constructor Declaration public Vector2 (float x , float y ); Description Constructs a new vector with given x, y components. ```csharp //This script moves a GameObject to a new x position using a Vector2. //Attach this script to a GameObject //Set your x position in the Inspectorusing UnityEngine;publ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_616315f312ac
unity_docs
editor
Give me an overview of the `BuildPipeline` class in Unity.
BuildPipeline class in UnityEditor Description Lets you programmatically build players or AssetBundles which can be loaded from the web. Static Properties Property Description isBuildingPlayer Is a player currently being built? Static Methods Method Description BuildAssetBundles Builds the AssetBundles in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_63e3a3983c6a
unity_docs
scripting
Show me a Unity C# example demonstrating `Handles.Label`.
ture to display on the label. content The text, image, and tooltip for this label. style The style to use for this label. If left out, the label style from the current GUISkin is used. Description Creates a text label for a handle that is positioned in 3D space. Labels have no user interaction and canot be cli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_729038420c40
unity_docs
editor
What is `TypeCache.GetTypesDerivedFrom` in Unity? Explain its purpose and usage.
TypeCache.GetTypesDerivedFrom Declaration public static TypeCache.TypeCollection GetTypesDerivedFrom (); Declaration public static TypeCache.TypeCollection GetTypesDerivedFrom (Type parentType ); Declaration public static TypeCache.TypeCollection GetTypesDerivedFrom (string assemblyName ); Declara...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_16df10cf43d9
unity_docs
editor
In Unity's 'Create and manage overlay configurations', what is 'Export an overlay preset' and how does it work?
To export an overlay configuration, save it as a file and then import it into another project: In the Scene view, press the ` key to display the Overlays menu. In the dropdown in the Overlays menu, select Save Preset To File . Choose a location to save the preset to. Name your overlay preset. Click Save .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_326f2dbc737b
unity_docs
physics
Show me a Unity C# example demonstrating `Collider.material`.
Collider.material public PhysicsMaterial material ; Description The material used by the collider. If material is shared by colliders, it will duplicate the material and assign it to the collider. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Expose properties in the inspector for ea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1f3fb44ae14e
unity_docs
physics
What is `ParticleSystemCollisionType` in Unity? Explain its purpose and usage.
ParticleSystemCollisionType enumeration Description The type of collisions to use for a given Particle System. Properties Property Description Planes Collide with a list of planes. World Collide with the world geometry.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_054e120cb930
unity_docs
scripting
What is `Android.GetAssetPackStateAsyncOperation` in Unity? Explain its purpose and usage.
GetAssetPackStateAsyncOperation class in UnityEngine.Android / Inherits from: CustomYieldInstruction / Implemented in: UnityEngine.AndroidJNIModule Description Represents an asynchronous Android asset pack state request operation. AndroidAssetPacks.GetAssetPackStateAsync returns an instance of this class. Y...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_b18623543eec
github
scripting
Write a Unity C# script called Command Invoker
```csharp using System.Reflection; using UnityEngine; namespace InGame_Console.InGame_Console_System.Scripts { public static class CommandInvoker { public static void InvokeCommand(string command, string DataKey = null) { var targetMember = ConsoleDatabase.GetCommand(comman...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_8aa6883ddec9
unity_docs
scripting
What is `SettingsService.Exists` in Unity? Explain its purpose and usage.
SettingsService.Exists Declaration public static bool Exists (string settingsPath ); Parameters Parameter Description settingsPath Settings path of the item to verify the existence of (for example, 'Project/Player' or 'Preferences/Search'). Returns bool Returns true if the settings path exists. Descri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_02cd9a0b56b7
unity_docs
animation
What is `HumanBone.humanName` in Unity? Explain its purpose and usage.
HumanBone.humanName public string humanName ; Description The name of the Mecanim human bone to which the bone from the model is mapped. To get a list of all available human bones, use HumanTrait.BoneName .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_61d333db8776
unity_docs
rendering
Show me a Unity C# example demonstrating `Texture2D.mipmapLimitGroup`.
mipmap limit group, this texture respects the TextureMipmapLimitSettings of that new group. Set this property in the constructor or in the texture importer, because you cannot set this property after creating the texture. If the texture has no mipmaps, this property has no effect. This code example demonstrates how t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86f13743434c
unity_docs
scripting
What is `Search.SearchProvider` in Unity? Explain its purpose and usage.
SearchProvider class in UnityEditor.Search Implements interfaces: ISerializationCallbackReceiver Description SearchProvider manages search for specific types of items and manages all fields of a SearchItem such as thumbnails, descriptions, subfilters. A first example that allows to search for specific prefabs an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9383a1d5f17f
unity_docs
scripting
Explain 'Call native plug-in for Android code' in Unity.
The process to call code in native plug-ins for Android is the same as standard native plug-ins . Note : If you use individual C/C++ source files as plug-ins, use __Internal as the plug-in name in the DllImport attribute. It’s best practice to wrap all native plug-in method calls with an additional C# code layer that: ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_767de1132fc8
unity_docs
scripting
Give me an overview of the `LightEditor` class in Unity.
LightEditor class in UnityEditor / Inherits from: Editor Description The class used to render the Light Editor when a Light is selected in the Unity Editor. Properties Property Description settings The settings helper that can be used for rendering a custom LightEditor. Public Methods Method Description...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5bac32a2f120
unity_docs
scripting
Show me a Unity C# example demonstrating `Random.rotationUniform`.
Random.rotationUniform public static Quaternion rotationUniform ; Description Returns a random rotation with uniform distribution (Read Only). Employs Hopf fibration to return a random Quaternion within a uniformly distributed selection space. Gives higher quality results compared to the more naive appro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5e04493e947c
unity_docs
rendering
Explain 'Visual Effect Graph' in Unity.
The Visual Effect Graph is a package that you can use to create large-scale visual effects for your Unity Project. The Visual Effect Graph simulates particle behavior on the GPU, which allows it to simulate many more particles than the Built-in Particle System . If you want to create visual effects that include a large...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_689ba14ba4e5
unity_docs
editor
What is `AssetDatabase.ActiveRefreshImportMode` in Unity? Explain its purpose and usage.
AssetDatabase.ActiveRefreshImportMode public static AssetDatabase.RefreshImportMode ActiveRefreshImportMode ; Description Gets the refresh import mode currently in use by the asset database. This mode defines the Editor's use of parallel processes when it imports assets during an asset database refresh.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f28ea4635f8c
unity_docs
physics
What is `Joint2D.breakTorque` in Unity? Explain its purpose and usage.
Joint2D.breakTorque public float breakTorque ; Description The torque that needs to be applied for this joint to break. When a joint tries to constrain a Rigidbody2D it may need to apply torque to do so. This is known as the reactionTorque . Each physics update, the breakTorque is compared to the reaction...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_196e47ffe93e
unity_docs
editor
Explain 'Registering an Action Handler' in Unity.
You can register actions for a Search Provider. Users can access registered actions via the More Options ( ⋮ ) icon in the search results. Note: Registering an action handler and registering a Search Provider are different processes. You can register new action handlers for existing Search Providers. To register an act...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ded943891dd2
unity_docs
scripting
Show me a Unity C# example demonstrating `Event.current`.
Event.current public static Event current ; Description The current event that's being processed right now. ```csharp using UnityEngine;public class Example : MonoBehaviour { void OnGUI() { Debug.Log("Current detected event: " + Event.current); } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_525961a8a4d9
unity_docs
physics
What is `Rigidbody2D.IsSleeping` in Unity? Explain its purpose and usage.
Rigidbody2D.IsSleeping Declaration public bool IsSleeping (); Description Is the rigidbody "sleeping"? Sleeping is an optimisation that is used to temporarily remove an object from physics simulation when it is at rest. This function tells if the rigidbody is currently sleeping. Additional resources: Sleep , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3296ff31865f
unity_docs
animation
What is `Animations.GameObjectRecorder.BindAll` in Unity? Explain its purpose and usage.
GameObjectRecorder.BindAll Declaration public void BindAll ( GameObject target , bool recursive ); Parameters Parameter Description target root or any of its children. recursive Binds also all the target 's children properties when set to true . Description Adds bindings for all of target 's proper...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_013c4c596dd7
unity_docs
scripting
What is `Progress.IsCancellable` in Unity? Explain its purpose and usage.
Progress.IsCancellable Declaration public static bool IsCancellable (int id ); Parameters Parameter Description id The progress indicator's unique ID. Returns bool True if you can cancel the task, false otherwise. Description Indicates whether you can cancel the progress indicator's associated task.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_08ff82dee53c_doc_3
github
scripting
What does `TryCalculateEntireHand` do in this Unity script? Explain its purpose and signature.
For a certain hand, query every Bone in the hand, and write all results to theHandJoints collection. Signature: ```csharp private void TryCalculateEntireHand() ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_9b46fb1e4dbb
unity_docs
audio
In Unity's 'Supported codecs for transparent videos (per-pixel alpha)', what is 'Apple ProRes 4444' and how does it work?
The Apple ProRes 4444 codec is a high-quality version of Apple ProRes for 4:4:4:4 image sources, including alpha channels. Some key information about this codec: Provides the same level of visual fidelity as the source video. Most Apple platforms have support for it. Typically produces large files, which increases stor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_260dc7d54f76
unity_docs
xr
Show me a Unity C# example demonstrating `Screen.SetResolution`.
overload that accepts the FullScreenMode parameter. Exclusive full-screen mode is only supported on Windows standalone Player. If you use multi-display , you can only use Screen.SetResolution to set the resolution of the primary screen. A resolution change is applied at the end of the current frame and not immed...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_824069c29e07
unity_docs
editor
What is `Search.SearchField` in Unity? Explain its purpose and usage.
SearchField struct in UnityEditor.Search Description Search item field used by the property table and selector systems. Properties Property Description alias Display label of the field if displayed in the property table. label Field property label that was selected. name Field selector name. Compared to labe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d5f9d370f872_doc_18
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Stores the "Right Hand" used with continuous movement when inputs should be relative to the right hand's orientation. Signature: ```csharp public Transform rightHandForwardSource ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b9588c45b261
unity_docs
scripting
In Unity's 'Aim Constraint component', what is 'Properties' and how does it work?
Property Description Activate After you rotate the constrained GameObject and move its source GameObjects, click Activate to save this information. Activate saves the current offset from the source GameObjects in Rotation At Rest and Rotation Offset , then enables Is Active and Lock . Zero Sets the rotation of the cons...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_383266df2c20
unity_docs
math
Show me a Unity C# example demonstrating `Color.linear`.
Color.linear public Color linear ; Description A linear value of an sRGB color. Colors are typically expressed in sRGB color space. This property returns "linearized" color value, i.e. with inverse of sRGB gamma curve applied. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.