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_07c985899d0c
unity_docs
editor
What is `SketchUpImporter.GetDefaultCamera` in Unity? Explain its purpose and usage.
SketchUpImporter.GetDefaultCamera Declaration public SketchUpImportCamera GetDefaultCamera (); Returns SketchUpImportCamera The default camera. Description The default camera or the camera of the active Scene which the SketchUp file was saved with. The following is an example of extracting the default ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_95d799c8b0eb
unity_docs
rendering
Show me a Unity C# example demonstrating `Rendering.GraphicsSettings.GetSettingsForRenderPipeline`.
ttings for the given RenderPipeline . This method iterates over all RenderPipelineGlobalSettings registered in the GraphicsSettings. If there is an instance registered for the given RenderPipeline , the method returns it, otherwise the method returns null. The function performs string comparison and may allocate ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cdb1e0f03425
unity_docs
ui
What is `EditorWindow.Focus` in Unity? Explain its purpose and usage.
EditorWindow.Focus Declaration public void Focus (); Description Moves keyboard focus to another EditorWindow. The Focus public method controls which window is active for use of the keyboard. In the examples below the active EditorWindow keyboard is changed to a different EditorWindow keyboard. Additional ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9ff9a9a2437a
unity_docs
rendering
In Unity's 'Transparent Cutout Bumped Specular', what is 'Normal Mapped Properties' and how does it work?
Like a Diffuse shader, this computes a simple (Lambertian) lighting model. The lighting on the surface decreases as the angle between it and the light decreases. The lighting depends only on the angle, and does not change as the camera moves or rotates around. Normal mapping simulates small surface details using a text...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_01bd260f2de5
unity_docs
rendering
What is `MaterialEditor.RenderQueueField` in Unity? Explain its purpose and usage.
MaterialEditor.RenderQueueField Declaration public void RenderQueueField (); Declaration public void RenderQueueField ( Rect r ); Description Display UI for editing material's render queue setting. The Render Queue UI allows you to set Material.renderQueue to one of the common values (e.g. Geometry or T...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1522ab9deb39
unity_docs
rendering
What is `WebCamTexture.ctor` in Unity? Explain its purpose and usage.
WebCamTexture Constructor Declaration public WebCamTexture (); Declaration public WebCamTexture (int requestedWidth , int requestedHeight , int requestedFPS ); Declaration public WebCamTexture (int requestedWidth , int requestedHeight ); Declaration public WebCamTexture (string deviceName ); Dec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c4d55ead8c19
unity_docs
rendering
What is `AssetImporters.TextureGenerationOutput.texture` in Unity? Explain its purpose and usage.
TextureGenerationOutput.texture public Texture2D texture ; Description This is a Texture2D generated by TextureGenerator.GenerateTexture based on the colorBuffer argument passed to that function. If the generator is configured to generate a non-2D texture (cubemap, 3D, ...), this member will always be nul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a6697566df42_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Enables the Magic Leap 2 XR plugin Signature: ```csharp public partial class EnablePluginStep : ISetupStep ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_b74da18aaddd
unity_docs
editor
Show me a Unity code example for 'Run Unity from a command-line interface'.
/Contents/MacOS/Unity -projectPath <project path> ## Launch Unity on Windows Type the following into the Command Prompt to launch Unity: "C:\Program Files\Unity\Hub\Editor\<version>\Editor\Unity.exe" -projectPath "<project path>" To prevent syntax errors on Windows, make sure the directory path doesn’t end with a sin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7ee87b237e4e
unity_docs
rendering
Show me a Unity code example for 'Use 16-bit precision in shaders'.
bit precision. You can use 16-bit precision instead in GPU calculations, which has the following benefits on mobile platforms: Shaders use less memory, bandwidth, and power. Calculations are faster. Using fewer bits can improve how the GPU allocates registers. ## Create a 16-bit variable To use 16-bit precision in a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4af9e5d71f41
unity_docs
math
What are the parameters of `Mathf.Cos` in Unity?
Returns float The return value between -1 and 1. Description Returns the cosine of angle f . Note: If using very large numbers with this function, there is an acceptable range for input angle values for this method, beyond which the calculation will fail. On windows, the acceptable range is approximately between -92233...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc30e80650bc
unity_docs
math
What is `Rendering.CommandBuffer.SetComputeMatrixParam` in Unity? Explain its purpose and usage.
CommandBuffer.SetComputeMatrixParam Declaration public void SetComputeMatrixParam ( ComputeShader computeShader , string name , Matrix4x4 val ); Declaration public void SetComputeMatrixParam ( ComputeShader computeShader , int nameID , Matrix4x4 val ); Parameters Parameter Description computeSh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_98b92862869c
unity_docs
scripting
What is `Unity.Collections.LowLevel.Unsafe.UnsafeUtility.PinGCArrayAndGetDataAddress` in Unity? Explain its purpose and usage.
UnsafeUtility.PinGCArrayAndGetDataAddress Declaration public static void* PinGCArrayAndGetDataAddress (Array target , out ulong gcHandle ); Parameters Parameter Description target The managed array to pin. It should be a valid array managed by the garbage collector. gcHandle The handle to associate with t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_bdaf4a557934
github
scripting
Write a Unity C# physics script for Bhaptics UI
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.UI; namespace Bhaptics.SDK2 { public class BhapticsUI : MonoBehaviour { [SerializeField] private float intervalRefreshTime = 1f; [SerializeField] private RectTransform mainPanel...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
gh_8cf44ea50a83
github
scripting
Write a Unity Editor script for Ginject Property Drawer
```csharp #if UNITY_EDITOR using UnityEditor; using UnityEngine; using GrimTools.Runtime; namespace GrimTools.Editor { [CustomPropertyDrawer(typeof(GinjectAttribute))] public class GinjectPropertyDrawer : PropertyDrawer { Texture2D icon; Texture2D LoadIcon() { if (icon ...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_f5fe58c02f6b
unity_docs
scripting
What is `HumanLimit.useDefaultValues` in Unity? Explain its purpose and usage.
HumanLimit.useDefaultValues public bool useDefaultValues ; Description Should this limit use the default values? You should set useDefaultValues to false if you want to use your own limit values, otherwise the defaults will override your settings.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_51397e4cb8fa
unity_docs
rendering
What is `Experimental.Rendering.GraphicsFormatUtility.IsBCFormat` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormatUtility.IsBCFormat Declaration public static bool IsBCFormat ( Experimental.Rendering.GraphicsFormat format ); Declaration public static bool IsBCFormat ( TextureFormat format ); Description Returns true...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75f658373d0f
unity_docs
ui
What is `EditorTools.ToolAttribute.toolPriority` in Unity? Explain its purpose and usage.
ToolAttribute.toolPriority public int toolPriority ; Description Tool priority defines the order that tools are displayed in within the Tools Overlay. Tools buttons are sorted in ascending order. The lowest values place tools at the left or top of the toolbar, depending on layout. The default priority is ToolA...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e7241dcfdde
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUILayout.FloatField`.
ride settings defined by the style . Additional resources: GUILayout.Width , GUILayout.Height , GUILayout.MinWidth , GUILayout.MaxWidth , GUILayout.MinHeight , GUILayout.MaxHeight , GUILayout.ExpandWidth , GUILayout.ExpandHeight . Returns float The value entered by the user. Description Make a text fi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d957962013e
unity_docs
scripting
What is `KeyCode.E` in Unity? Explain its purpose and usage.
KeyCode.E Description 'e' key. ```csharp //Attach this to a GameObject //This script tells when the E arrow key is pressed down and when it is released using UnityEngine;public class Example : MonoBehaviour { void Update() { //Detect when the E arrow key is pressed down if (Input.GetKeyDown(KeyCode.E)) Debug.L...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9669a2c59362
unity_docs
scripting
Show me a Unity code example for 'MaskField'.
control that lets users select one or more options from a list of options. Note : To align an element with other fields in an Inspector window, simply apply the.unity-base-field__aligned USS class to it. For more information, refer to BaseField . ## Create a MaskField You can create a MaskField with UI Builder, UXML,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5218a80c2f21
unity_docs
ui
Show me a Unity C# example demonstrating `GUIStyle.onFocused`.
GUIStyle.onFocused public GUIStyleState onFocused ; Description Rendering settings for when the element has keyboard and is turned on. ```csharp using UnityEngine;public class Example : MonoBehaviour { void OnGUI() { GUI.skin.button.onFocused.textColor = Color.green; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_15893c60d245
unity_docs
scripting
What is `Search.StringView.operator_eq` in Unity? Explain its purpose and usage.
StringView.operator == public static bool operator == (stringView lhs , stringView rhs ); Parameters Parameter Description lhs A StringView . rhs A StringView . Description The equals operator. public static bool operator == (stringView lhs , string rhs ); Parameters Parameter Description lh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_07c751cc98f2
unity_docs
rendering
Explain 'Lifetime by Emitter Speed module reference' in Unity.
This module controls the initial lifetime of each particle based on the speed of the emitter when the particle spawns. ## Properties For some properties in this section, you can use different modes to set their value. For information on the modes you can use, refer to Vary Particle System properties over time . Prope...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55ebbef90312
unity_docs
editor
What are the parameters of `EditorGUILayout.ObjectField` in Unity?
Returns Object The object that has been set by the user. Description Make a field to receive any object type. You can assign objects either by drag and drop or by selecting an object using the Object Picker. Ensure that the allowSceneObjects parameter is false if the object reference is stored as part of an asset, sinc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a142b1a7f23c
unity_docs
scripting
What is `Search.SearchUtils.GetAssetPath` in Unity? Explain its purpose and usage.
SearchUtils.GetAssetPath Declaration public static string GetAssetPath (ref Search.SearchItem item ); Parameters Parameter Description item Search item. Returns string Asset path of the item or null if none can be found. Description Returns the asset path of a search item if any. The returned asse...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c223681086aa
unity_docs
rendering
In Unity's 'Introduction to rendering paths in the Built-In Render Pipeline', what is 'Rendering Path comparison' and how does it work?
Deferred Forward Vertex Lit Features Per-pixel lighting (normal maps, light cookies) Yes Yes - Real-time shadows Yes With caveats - Reflection Probes Yes Yes - Depth & Normal Buffers Yes Additional render passes - Soft Particles Yes - - Semi-transparent objects - Yes Yes Anti-Aliasing - Yes Yes Light Culling Masks Limi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0a212619fc54_doc_12
github
scripting
What does `IPoolable` do in this Unity script? Explain its purpose and signature.
Throws an exception indicating no pool was found for the specified type.The type of the poolable object. Signature: ```csharp public static void ThrowNoPoolFoundException<T>() where T : IPoolable => throw new InvalidOperationException($"No pool found for type ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_94ef1a23243d
unity_docs
rendering
What is `Rendering.RayTracingMeshInstanceConfig.lightProbeUsage` in Unity? Explain its purpose and usage.
RayTracingMeshInstanceConfig.lightProbeUsage public Rendering.LightProbeUsage lightProbeUsage ; Description The Light probe interpolation type for this instance. Additional resources: LightProbeUsage .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_988ab0f8c5fe
unity_docs
math
What is `BoundsInt.allPositionsWithin` in Unity? Explain its purpose and usage.
BoundsInt.allPositionsWithin public BoundsInt.PositionEnumerator allPositionsWithin ; Description A BoundsInt.PositionCollection that contains all positions within the BoundsInt . Positions within the BoundsInt are not inclusive of the positions on the upper limits of the BoundsInt. This iterator will only r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c09fe4dfba4a
unity_docs
rendering
What are the parameters of `AssetDatabase.GetTypeFromPathAndFileID` in Unity?
Returns Type The object's type. Description Gets an object's type from an Asset path and a local file identifier. The following script example shows how to get the types of a nested asset. A material asset is added to a scriptable object asset (in this case called DummyObject), and the types of these two assets are ext...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_605d635b5783
unity_docs
math
What is `AndroidJNIHelper.GetSignature` in Unity? Explain its purpose and usage.
AndroidJNIHelper.GetSignature Declaration public static string GetSignature (object obj ); Parameters Parameter Description obj Object for which a signature is to be produced. Description Creates the JNI signature string for particular object type. Declaration public static string GetSignature (object[] ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_52afc70647ae
unity_docs
ui
Show me a Unity code example for 'Click events'.
kEvent has no unique properties, but inherits all properties from its base class. You can find a list of properties on the Pointer Events page. ## ClickEvent Unity sends this event when the left mouse button is clicked over a visual element. target : The element underneath the mouse or pointing device when the click ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ae30b7531d59
unity_docs
input
Show me a Unity C# example demonstrating `KeyCode.Mouse2`.
KeyCode.Mouse2 Description Middle mouse button (or third button). Use this to detect middle mouse button presses. The “2” mouse button is the third button on the user’s mouse, which is usually the middle mouse button (often a clickable scroll wheel). Unity defines this as the "2" mouse button, as the mouse button n...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0a3af7479326
unity_docs
physics
What is `Rigidbody.ResetCenterOfMass` in Unity? Explain its purpose and usage.
Rigidbody.ResetCenterOfMass Declaration public void ResetCenterOfMass (); Description Reset the center of mass of the rigidbody. Computes the actual center of mass of the rigidbody from all the colliders attached, and stores it. After calling this function, the center of mass will get updated automatically aft...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8834eb1d2bbb
unity_docs
xr
What are the parameters of `Search.SearchService.GetItems` in Unity?
Returns List<SearchItem> A list of search items matching the search query. Description Initiates a search and returns all search items matching the search context. Other items can be found later using asynchronous searches. Unity suggests using SearchService.Request to execute a search query. GetItems usually requires ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b628c5a5eda8
unity_docs
rendering
Show me a Unity C# example demonstrating `GUILayout.BeginHorizontal`.
ces: GUILayout.Width , GUILayout.Height , GUILayout.MinWidth , GUILayout.MaxWidth , GUILayout.MinHeight , GUILayout.MaxHeight , GUILayout.ExpandWidth , GUILayout.ExpandHeight . Description Begin a Horizontal control group. All controls rendered inside this element will be placed horizontally next to each oth...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_97487018e6f9
unity_docs
scripting
What is `EditorWindow` in Unity? Explain its purpose and usage.
EditorWindow class in UnityEditor / Inherits from: ScriptableObject Description Derive from this class to create a custom Editor window. Use this class to create Editor windows that can either float independently or dock as tabs, similar to the default windows in the Unity Editor. You can use the MenuItem att...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bf8d9d929cc1
unity_docs
rendering
What is `Renderer.GetPropertyBlock` in Unity? Explain its purpose and usage.
Renderer.GetPropertyBlock Declaration public void GetPropertyBlock ( MaterialPropertyBlock properties ); Declaration public void GetPropertyBlock ( MaterialPropertyBlock properties , int materialIndex ); Parameters Parameter Description properties Material parameters to retrieve. materialIndex The ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fd4d9d52b756
unity_docs
xr
What is `RenderTexture.GetTemporary` in Unity? Explain its purpose and usage.
RenderTexture.GetTemporary Declaration public static RenderTexture GetTemporary ( RenderTextureDescriptor desc ); Declaration public static RenderTexture GetTemporary (int width , int height , int depthBuffer = 0, RenderTextureFormat format = RenderTextureFormat.Default, RenderTextureReadWrite ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_da4c84aee159
github
scripting
Write a Unity C# MonoBehaviour script called Pooling Object
```csharp using UnityEngine; namespace pooling { //Abstract class to be inherited to be able to use Pooling.cs public abstract class PoolingObject : MonoBehaviour, IPooling { public virtual string objectName{ get { return ""; } } public bool isUsing { get; set; } //Gets called whenever is collected...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_8d273faf8964
unity_docs
scripting
Show me a Unity C# example demonstrating `LightProbes.SetPositionsSelf`.
object. When you change the positions of baked light probes using this method, you must call LightProbes.Tetrahedralize or LightProbes.TetrahedralizeAsync to fully apply the changes. Setting duplicate light probe positions will lead to incorrect behavior, such as black light probes appearing.. The following script...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7c942a25b9d6
unity_docs
ui
What are the parameters of `EditorGUILayout.MinMaxSlider` in Unity?
Description Make a special slider the user can use to specify a range between a min and a max. Moves the selected object randomly betweeen the interval. ```csharp // Place the selected object randomly between the interval of the Min Max Slider // in the X,Y,Z coordsusing UnityEditor; using UnityEngine;public class Exam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3cfd09ef30dd
unity_docs
scripting
What is `SceneManagement.Stage.assetPath` in Unity? Explain its purpose and usage.
Stage.assetPath public string assetPath ; Description The path of the Asset file associated with the stage, relative to the project root folder. The path is null if there are no specific Asset associated with the stage.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7abc1f5096ff
unity_docs
scripting
Explain 'Meshes' in Unity.
Resources and strategies for understanding, creating, and configuring meshes in Unity. Page Description Get started with meshes Introductory information about meshes, and information about the data that a mesh contains. Creating meshes How to work with meshes in C# scripts . Text meshes Generate 3D geometry that displa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2edf237f4790
unity_docs
rendering
What are the parameters of `Material.SetTextureScale` in Unity?
Description Sets the placement scale of texture propertyName . Additional resources: mainTextureScale property, GetTextureScale , SetTexture . ```csharp using UnityEngine;public class Example : MonoBehaviour { // Scroll main texture based on time float scrollSpeed = 0.5f; Renderer rend; void Start() {...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c168ec7e832a
unity_docs
scripting
Show me a Unity C# example demonstrating `Transform.LookAt`.
he transform so the forward vector points at /target/'s current position. Then it rotates the transform to point its up direction vector in the direction determined by the worldUp parameter. If you leave out the worldUp parameter, the function will use the world y axis. The up vector of the rotation will only matc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_613d301c3b89
unity_docs
math
What are the parameters of `Physics.BoxCast` in Unity?
Returns bool True, if any intersections were found. Description Casts the box along a ray and returns detailed information on what was hit. Declaration public static bool BoxCast ( Vector3 center , Vector3 halfExtents , Vector3 direction , out RaycastHit hitInfo , Quaternion orientation = Quaternion.identity, float max...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_75be3df182f1
unity_docs
rendering
In Unity's 'Memory Profiler module reference', what is 'Module details pane' and how does it work?
When you select the Memory module, the details pane displays a breakdown of where Unity allocated memory in your application. The dropdown has the following options: View Description Simple view Displays a basic overview of where Unity allocated memory in your application. Detailed view Important: This view is deprecat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d12e79eae0b0
unity_docs
scripting
Give me an overview of the `CrashReport` class in Unity.
CrashReport class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Holds data for a single application crash event and provides access to all gathered crash reports. If compiled with appropriate settings, Unity will try to gather useful information, like location and thread stack traces, when...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1b7a0803ce59
unity_docs
scripting
What is `SceneManagement.UnloadSceneOptions` in Unity? Explain its purpose and usage.
UnloadSceneOptions enumeration Description Scene unloading options passed to SceneManager.UnloadScene. Properties Property Description None Unload the scene without any special options. UnloadAllEmbeddedSceneObjects Unloads all objects that are loaded from the scene's serialized file. Without this flag, only G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7d19d3a33c15
unity_docs
rendering
In Unity's 'Trace and manage PSO data collections', what is 'Trace a new PSO data collection' and how does it work?
Trace PSOs in your project and create a GraphicsStateCollection asset (a PSO data collection), which stores information about the combinations of shader variants and graphics state your application uses. To trace a new PSO data collection, follow these steps: Create a new GraphicsStateCollection in a C# script. This ne...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_47e95264bbcd
unity_docs
scripting
What is `UIElements.Painter2D.miterLimit` in Unity? Explain its purpose and usage.
Painter2D.miterLimit public float miterLimit ; Description When using LineJoin.Miter joins, this defines the limit on the ratio of the miter length to the stroke width before converting the miter to a bevel.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8ad84804f516
unity_docs
editor
Show me a Unity code example for 'Registering an Action Handler'.
s. 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 action, you create a function tagged with the SearchActionsProvider attribute. This function must return an IEnumerable<SearchAction> . The...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_312f5190dfb8
unity_docs
networking
In Unity's 'Matchmaker', what is 'Compatible with Unity' and how does it work?
These package versions are available in Unity version 6000.0: Documentation location: State Versions available: com.unity.services.matchmaker@1.2 released 1.2.0 com.unity.services.matchmaker@1.1 released 1.1.5
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_113fc7a38ac6
unity_docs
rendering
Show me a Unity code example for 'Example of using UNITY_DOTS_INSTANCED_PROP macros in a DOTS Instancing shader in URP'.
_DOTS_INSTANCED_PROP_OVERRIDE_REQUIRED(PropertyType, PropertyName) These macros allow you to specify if a property can be instanced or not at compile-time. It allows the access macros such as UNITY_ACCESS_DOTS_INSTANCED_PROP to expand to more optimal code and can have significant impact on low-end platforms. Here is an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_639df5e42969
unity_docs
physics
Explain 'Build a player from the command line' in Unity.
You can build a Unity Player from the command line without opening the Unity Editor. This is useful for automated builds in continuous integration (CI) systems and build pipelines. There are several approaches to building a Player from the command line: Build type Command line details Build with a build target Use the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f7a7ada1056
unity_docs
editor
What is `EditorGUILayout.EditorToolbar` in Unity? Explain its purpose and usage.
EditorGUILayout.EditorToolbar Declaration public static void EditorToolbar (params EditorTool[] tools ); Declaration public static void EditorToolbar (IList<T> tools ); Parameters Parameter Description tools The collection of editor tools for the toolbar. Description Makes a toolbar populated with the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5117c79a2b39
unity_docs
rendering
What is `Material.RevertPropertyOverride` in Unity? Explain its purpose and usage.
Material.RevertPropertyOverride Declaration public void RevertPropertyOverride (string name ); Declaration public void RevertPropertyOverride (int nameID ); Parameters Parameter Description nameID Property name ID, use Shader.PropertyToID to get it. name Property name, e.g. "_SrcBlend". Descriptio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_35ec386f5854
unity_docs
animation
What is `WrapMode.ClampForever` in Unity? Explain its purpose and usage.
WrapMode.ClampForever Description Plays back the animation. When it reaches the end, it will keep playing the last frame and never stop playing. When playing backwards it will reach the first frame and will keep playing that. This is useful for additive animations, which should never be stopped when they reach the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_504e5f908433
unity_docs
performance
In Unity's 'Bucket allocator example', what is 'Example configuration' and how does it work?
The bucket allocator reserves blocks of memory for allocations. Each block is divided into subsections of 16 KB. The following example configuration demonstrates the process of reserving blocks for allocations: In this setup, the total block size ( Bucket Allocator Block Size ) is 4 MB, and the granularity of allocatio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_abe68b86d709
unity_docs
physics
Show me a Unity C# example demonstrating `RaycastHit2D.operator_RaycastHit2D`.
check to see if it contains a valid result which indicates a hit (intersection) was detected. You can do this by checking if the RaycastHit2D is true or false . NOTE: A valid result is indicated by the field RaycastHit2D.Collider referring to a valid Collider2D i.e. not being NULL. This operator is therefore eq...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ffbe2285f27a
unity_docs
rendering
What is `Rendering.RayTracingAccelerationStructure.Settings.layerMask` in Unity? Explain its purpose and usage.
RayTracingAccelerationStructure.Settings.layerMask public int layerMask ; Description A 32-bit mask that controls which layers a GameObject must be on to add it to the RayTracingAccelerationStructure. Unity interprets the mask as binary. So a mask value of -1 allows you to add renderers from all layers to the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_723d10f440f7
unity_docs
scripting
Show me a Unity C# example demonstrating `RigidbodyConstraints.FreezeRotation`.
RigidbodyConstraints.FreezeRotation Description Freeze rotation along all axes. ```csharp //Attach this script to a GameObject with a Rigidbody. Press the up and down keys to move the Rigidbody up and down. //Press the space key to freeze all rotations, but notice the positions still change.using UnityEngine;public...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ded6334bc2e5
unity_docs
math
What is `Quaternion.Euler` in Unity? Explain its purpose and usage.
Quaternion.Euler Declaration public static Quaternion Euler (float x , float y , float z ); Parameters Parameter Description x Rotation in degrees around the x-axis. y Rotation in degrees around the y-axis. z Rotation in degrees around the z-axis. Returns Quaternion The Euler angle rotation spec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2f8121f5ddd
unity_docs
editor
What is `EditorUserSettings.artifactGarbageCollection` in Unity? Explain its purpose and usage.
EditorUserSettings.artifactGarbageCollection public static bool artifactGarbageCollection ; Description Control whether artifact garbage collection is performed when the Editor starts up. By default, when you start the Editor, Unity removes unused artifact files in the Library folder, and removes their entries ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e867be276aec
unity_docs
scripting
What is `AndroidJNI.SetLongField` in Unity? Explain its purpose and usage.
AndroidJNI.SetLongField Declaration public static void SetLongField (IntPtr obj , IntPtr fieldID , long val ); Description Sets the value of an instance field of the specified object. Additional resources: Java Native Interface Specification (Oracle)
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0dd6cfd7453b
unity_docs
rendering
What is `Device.SystemInfo` in Unity? Explain its purpose and usage.
SystemInfo class in UnityEngine.Device / Implemented in: UnityEngine.CoreModule Description Access platform-specific system and hardware information. This class has the same functionality as SystemInfo and also mimics platform-specific behavior in the Unity Editor. Use it together with the Device Simulator to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a34c3cd23733
unity_docs
scripting
What is `Display.systemHeight` in Unity? Explain its purpose and usage.
Display.systemHeight public int systemHeight ; Description Vertical native display resolution. Actual rendering resolution might be different, see Display.renderingHeight . Additional resources: systemWidth , renderingHeight .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_60e78e6f367e
unity_docs
scripting
What is `AwaitableCompletionSource_1.TrySetException` in Unity? Explain its purpose and usage.
AwaitableCompletionSource<T0>.TrySetException Declaration public bool TrySetException (Exception exception ); Parameters Parameter Description exception Exception to raise in the continuation. Returns bool Indicates if the completion was successfully raised. Description Raise completion with an excep...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f1825b80cfa8
unity_docs
scripting
What is `AudioType.AIFF` in Unity? Explain its purpose and usage.
AudioType.AIFF Description The audio file you want to stream has the Audio Interchange File Format (AIFF) audio file format. Unity doesn’t support this format. Use this enumeration value to specify the format type of the audio file has the AIFF audio file format. If the audio file has a different format, Unity migh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_753008e07d1d
unity_docs
scripting
Show me a Unity code example for 'Troubleshooting on iOS devices'.
traces are a useful tool for fault investigation, but using them requires some expertise. You generally can’t continue after these hardware memory access faults happen. To access a native stack trace, type bt all into the Xcode debugger console. Inspect the printed stack traces as they can contain information about whe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bcf080ae5dbc
unity_docs
physics
What is `Physics2D.OverlapPoint` in Unity? Explain its purpose and usage.
Physics2D.OverlapPoint Declaration public static Collider2D OverlapPoint ( Vector2 point , int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity); Parameters Parameter Description point A point in world space. layerMask Filter to check objects only...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e839adbbf409
unity_docs
scripting
What is `Rendering.ScriptableCullingParameters.reflectionProbeSortingCriteria` in Unity? Explain its purpose and usage.
ScriptableCullingParameters.reflectionProbeSortingCriteria public Rendering.ReflectionProbeSortingCriteria reflectionProbeSortingCriteria ; Description Reflection Probe Sort options for the cull.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2498e75fba66
unity_docs
rendering
What is `Shader.GetGlobalInteger` in Unity? Explain its purpose and usage.
Shader.GetGlobalInteger Declaration public static int GetGlobalInteger (string name ); Declaration public static int GetGlobalInteger (int nameID ); Parameters Parameter Description nameID The name ID of the property retrieved by Shader.PropertyToID . name The name of the property. Description Get...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c19d367908a2
unity_docs
physics
Show me a Unity C# example demonstrating `Collider2D.OnCollisionEnter2D`.
hen an incoming collider makes contact with this object's collider (2D physics only). Further information about the collision is reported in the Collision 2D parameter passed during the call. Notes: Collision events will be sent to disabled MonoBehaviours, to allow enabling Behaviours in response to collisions. Additi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ac5b000b5363
unity_docs
rendering
Explain 'Transparent Vertex-Lit' in Unity.
Note. Unity 5 introduced the Standard Shader which replaces this shader . ## Transparent Properties Note. Unity 5 introduced the Standard Shader which replaces this shader. This shader can make mesh geometry partially or fully transparent by reading the alpha channel of the main texture. In the alpha, 0 (black) is co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d7440ae0e1fe
unity_docs
audio
What is `Video.VideoPlayer.IsAudioTrackEnabled` in Unity? Explain its purpose and usage.
VideoPlayer.IsAudioTrackEnabled Declaration public bool IsAudioTrackEnabled (ushort trackIndex ); Parameters Parameter Description trackIndex Index of the audio track being queried. Returns bool Returns true if decoding for the specified audio track is enabled. Description Whether decoding for the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b64e271b9682
unity_docs
input
Give me an overview of the `WindowsGamepadBackendHint` class in Unity.
WindowsGamepadBackendHint enumeration Description Specifies the desired Windows API to be used for input. Properties Property Description WindowsGamepadBackendHintDefault Select a Windows Input API automatically based on platform support. WindowsGamepadBackendHintXInput Windows XInput API. WindowsGamepadBacke...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f5da53fa16ba
unity_docs
scripting
What is `Android.AndroidApplication.currentActivity` in Unity? Explain its purpose and usage.
AndroidApplication.currentActivity public static AndroidJavaObject currentActivity ; Description Indicates the Java instance of the current activity. Notes: This object is managed by Unity runtime, so do not call AndroidJavaObject.Dispose on it. If the application is a service rather than an activity, thi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f91a775831ed
unity_docs
editor
What is `UIElements.IToolbarMenuElement` in Unity? Explain its purpose and usage.
IToolbarMenuElement interface in UnityEditor.UIElements Description An interface for toolbar items that display drop-down menus. Properties Property Description menu The drop-down menu for the element.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f12ab5b13d4a
unity_docs
editor
Show me a Unity C# example demonstrating `BuildAssetBundleOptions.None`.
BuildAssetBundleOptions.None Description Build assetBundle without any special option. ```csharp //Create a folder (right click in the Assets folder and go to Create>Folder), and name it “Editor” if it doesn’t already exist //Place this script in the Editor folder//This script creates a new Menu named “Build Asset”...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57ab3465352b
unity_docs
scripting
What is `SerializedProperty.objectReferenceValue` in Unity? Explain its purpose and usage.
SerializedProperty.objectReferenceValue public Object objectReferenceValue ; Description Value of an object reference property. Additional resources: propertyType , SerializedPropertyType.ObjectReference .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b00944b244d2
unity_docs
audio
What are the parameters of `Networking.UnityWebRequestMultimedia.GetAudioClip` in Unity?
Returns UnityWebRequest A UnityWebRequest properly configured to download an audio clip and convert it to an AudioClip . Description Create a UnityWebRequest to download an audio clip via HTTP GET and create an AudioClip based on the retrieved data. This method creates a UnityWebRequest and sets the target URL to the s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9fcf11eff891
github
scripting
Write a Unity C# UI script for Container
```csharp using System; using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.UI; public class Container : MonoBehaviour { #region Singleton public static Container instance; private void Awake() { if (instance != null) { Debug.Log("More tha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3c0cdd0ab3d2
unity_docs
editor
What is `Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle.SetAllowSecondaryVersionWriting` in Unity? Explain its purpose and usage.
AtomicSafetyHandle.SetAllowSecondaryVersionWriting Declaration public static void SetAllowSecondaryVersionWriting ( Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle handle , bool allowWriting ); Parameters Parameter Description handle The AtomicSafetyHandle of the NativeContainer. allowWriting If tru...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9c1e733ab230
unity_docs
editor
What is `iOS.Xcode.PBXProject.ContainsFileByProjectPath` in Unity? Explain its purpose and usage.
PBXProject.ContainsFileByProjectPath Declaration public bool ContainsFileByProjectPath (string path ); Parameters Parameter Description path The project path of the file. Returns bool Returns true if the project contains the file. Description Checks if the project contains a file with the given proje...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_955e8559b598
unity_docs
rendering
Give me an overview of the `IconKind` class in Unity.
IconKind enumeration Description Icon kind. This enum is used when modifying and inspecting the role an icon has within an application in PlayerSettings. Properties Property Description Any This icon can be used for any purpose in an application. Application This icon is used for the main application icons. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_87b7e800c79b
unity_docs
scripting
What is `TextAreaAttribute` in Unity? Explain its purpose and usage.
TextAreaAttribute class in UnityEngine / Inherits from: PropertyAttribute / Implemented in: UnityEngine.CoreModule Description Attribute to make a string be edited with a height-flexible and scrollable text area. You can specify the minimum and maximum lines for the TextArea, and the field will expand accordi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d1b9e02adea3
unity_docs
scripting
Explain 'Deploy a Web application' in Unity.
To deploy a Web build, you must configure your server and make sure you’re using the correct response headers, so that the browser receives a proper response and processes it correctly. There are two main settings in Unity that affect how you set up the server: Compression Format : Determines how Unity compresses files...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6f2a5c4e10aa
github
scripting
Write a Unity C# script called Bool Variable Toggle
```csharp using GI.UnityToolkit.Variables; using UnityEngine; namespace GI.UnityToolkit.Components.UI.Variables { /// <summary> /// Handles syncing a bool variable with a Toggle component (Unity UI). /// </summary> public class BoolVariableToggle : ToggleComponent { [SerializeField] private...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_459e99bf2838
unity_docs
editor
What is `Profiling.HierarchyFrameDataView.ResolveItemMergedSampleCallstack` in Unity? Explain its purpose and usage.
HierarchyFrameDataView.ResolveItemMergedSampleCallstack Declaration public string ResolveItemMergedSampleCallstack (int id , int sampleIndex ); Parameters Parameter Description id Hierarchy item identifier. sampleIndex Merged sample index. Returns string Returns the callstack associated with the speci...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_078342d4140e
unity_docs
rendering
Explain 'Optimizing GPU texture memory with mipmap streaming' in Unity.
Use mipmap streaming to limit the size of textures in GPU memory. Page Description Introduction to mipmap streaming How mipmap streaming works, and its limitations. Use mipmap streaming Enable mipmap streaming, make a texture work with mipmap streaming, and change the mipmap level of a texture. Configure mipmap streami...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bf6b28a6d6d0
unity_docs
scripting
Explain 'Create and manage build profiles' in Unity.
Create and manage build profiles to configure your application for multiple platforms. To create a build profile, use the following steps: Navigate to File > Build Profiles . In the Build Profiles window, select Add Build Profile to open the Platform Browser window. The Platform Browser window presents a list of suppor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7ec99a2da741
unity_docs
ui
In Unity's 'Searching in the Unity Editor introduction', what is 'Search for GameObjects in the Scene view and Hierarchy window' and how does it work?
Both the Scene view and the Hierarchy window have a search bar that allows you to search for GameObjects by name or type. The Scene view and Hierarchy window represent the same information, and when you use one search bar, Unity automatically populates the other search bar with the same text. A search term acts as a fi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_30408a108e94
unity_docs
physics
What is `ContactFilter2D.useTriggers` in Unity? Explain its purpose and usage.
ContactFilter2D.useTriggers public bool useTriggers ; Description Sets to filter contact results based on trigger collider involvement. Set to false to ignore any contacts involving trigger colliders. Set to true, to filter any contacts involving triggers and return such contacts. Note: Contacts filtered by in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_934dcbcc0186
unity_docs
performance
What is `ParticleSystemJobs.ParticleSystemNativeArray4` in Unity? Explain its purpose and usage.
ParticleSystemNativeArray4 struct in UnityEngine.ParticleSystemJobs / Implemented in: UnityEngine.ParticleSystemModule Description A container to hold 4 arrays of data for particles. Properties Property Description w The w-axis value for each particle. x The x-axis value for each particle. y The y-axis val...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_406abbe256f6
unity_docs
scripting
In Unity's 'Create an Android Library plug-in', what is 'Develop Android Library plug-ins' and how does it work?
As the source files of the Android Library plug-ins aren’t visible in the Unity C# project, modifying or further developing the plug-in requires additional steps as follows: Open the Build Profiles (menu: File > Build Profiles ) window. From the list of platforms in the Platforms panel, select Android . Under Platform ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e95fca884595
unity_docs
rendering
What are the parameters of `Material.SetColor` in Unity?
Description Sets the value of a color- or vector-type property. Many shaders use more than one color. Use SetColor to change the color (identified by shader property name, or unique property name ID). The behavior of this method depends on aspects of the target property and the project's active color space. A material ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d336c29a0db0
unity_docs
performance
Show me a Unity C# example demonstrating `Jobs.IJobParallelForTransform`.
IJobParallelForTransform interface in UnityEngine.Jobs Description An interface that allows you to perform the same independent operation for each position, rotation and scale of all the transforms passed into a job. ```csharp using UnityEngine; using Unity.Collections; using Unity.Jobs; using UnityEngine.Jobs;cl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.