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_49e361bee25c
unity_docs
scripting
What is `Search.IPropertyDatabaseView.CreateRecordKey` in Unity? Explain its purpose and usage.
IPropertyDatabaseView.CreateRecordKey Declaration public Search.PropertyDatabaseRecordKey CreateRecordKey (string documentId , string propertyPath ); Parameters Parameter Description documentId A document identifier. propertyPath A property path or name. Returns PropertyDatabaseRecordKey The record ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86cecb272e79
unity_docs
xr
What is `DedicatedServer.Arguments` in Unity? Explain its purpose and usage.
Arguments class in UnityEngine.DedicatedServer / Implemented in: UnityEngine.CoreModule Description DedicatedServer.Arguments provides accessors for common CLI options Static Properties Property Description ErrorPolicy ErrorPolicy defines how errors in arguments are handled. LogLevel LogLevel defines the lo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b358ae6abc49
unity_docs
animation
What is `Animator.StringToHash` in Unity? Explain its purpose and usage.
Animator.StringToHash Declaration public static int StringToHash (string name ); Parameters Parameter Description name The string to convert to Id. Description Generates a parameter id from a string. Ids are used for optimized setters and getters on parameters.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_17116e224fc7
github
scripting
Write a Unity C# script called Addressable Post Processing Profile
```csharp using UnityEngine; using UnityEngine.Rendering.PostProcessing; namespace PassivePicasso.SimplyAddress { [ExecuteAlways] public class AddressablePostProcessingProfile : AddressableArrayAssigner<PostProcessVolume, PostProcessProfile> { protected override void Assign(PostProcessVolume volum...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_f2893f8b7e8a
unity_docs
scripting
What is `Terrain.treeMaximumFullLODCount` in Unity? Explain its purpose and usage.
Terrain.treeMaximumFullLODCount public int treeMaximumFullLODCount ; Description Maximum number of trees rendered at full LOD. This is an easy setting to prevent too many trees being rendered at too high resolution in dense forests. Since there will be no fade if treeMaximumFullLODCount is exceeded you should...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_436916c9861c
unity_docs
math
What is `Bounds.IntersectRay` in Unity? Explain its purpose and usage.
Bounds.IntersectRay Declaration public bool IntersectRay ( Ray ray ); Description Does ray intersect this bounding box? ```csharp using UnityEngine;public class Example : MonoBehaviour { // Function to detect if a ray (representing a beam weapon, say) // makes contact with the collider's bounds. Collider ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_941bae48e851
unity_docs
scripting
What are the parameters of `ObjectFactory.CreateGameObject` in Unity?
Returns GameObject Returns the GameObject that was created. Description Creates a new GameObject. ```csharp using UnityEngine; using UnityEditor;public class CreateComponentExample { [MenuItem("ObjectFactoryExample/Create Camera GameObject")] public void CreateCameraEditor() { Selection.activeGameOb...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0978f9afdc62
unity_docs
rendering
In Unity's 'Override the mipmap level of a texture', what is 'Use the API' and how does it work?
Use the following APIs: Texture2D.requestedMipmapLevel to request that Unity overrides the mipmap level of the texture. Texture2D.IsRequestedMipmapLevelLoaded to check if Unity loads your requested mipmap level. Texture2D.ClearRequestedMipmapLevel if you no longer want to override the mipmap level. You can use the Mesh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c35da7d8e315
unity_docs
rendering
What is `MaterialPropertyDrawer` in Unity? Explain its purpose and usage.
MaterialPropertyDrawer class in UnityEditor Description Base class to derive custom material property drawers from. Use this to create custom UI drawers for your material properties, without having to write custom MaterialEditor classes. This is similar to how PropertyDrawer enables custom UI without writing ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_81c9faef5f3b
unity_docs
scripting
Show me a Unity C# example demonstrating `GUILayout.PasswordField`.
the example. maskChar Character to mask the password with. maxLength The maximum length of the string. If left out, the user can type for ever and ever. style The style to use. If left out, the textField style from the current GUISkin is used. Returns string The edited password. Description Make a tex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b22c1a938aad
unity_docs
scripting
In Unity's 'Introduction to programming in Unity', what is 'How scripting in Unity works' and how does it work?
C# scripts (files with a.cs file extension) are assets in your project, stored in the Assets folder and saved as part of the asset database . You can create template scripts that derive from the common built-in Unity types through the Scripting submenu of the Assets > Create menu. You configure a default External Scrip...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c063ee4978b
unity_docs
networking
What is `Android.AndroidColorModeHdr` in Unity? Explain its purpose and usage.
AndroidColorModeHdr enumeration Description Options to indicate whether the screen can display a wide range brightness levels. Additional resources: AndroidConfiguration.colorModeHdr Properties Property Description Undefined Mirrors the Android property value COLOR_MODE_HDR_UNDEFINED No Mirrors the Android p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_60e3466e995d
unity_docs
scripting
What is `Compilation.CompilationPipeline.GetAssemblyDefinitionFilePathFromAssemblyReference` in Unity? Explain its purpose and usage.
CompilationPipeline.GetAssemblyDefinitionFilePathFromAssemblyReference Declaration public static string GetAssemblyDefinitionFilePathFromAssemblyReference (string reference ); Parameters Parameter Description reference The assembly definition file GUID or assembly name reference. Returns string The file ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6e6ce5a8910
unity_docs
ui
What is `UIElements.Scroller.ScrollPageUp` in Unity? Explain its purpose and usage.
Scroller.ScrollPageUp Declaration public void ScrollPageUp (); Description Will change the value according to the current slider pageSize. Declaration public void ScrollPageUp (float factor ); Description Will change the value according to the current slider pageSize.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f99c5649a8f3
unity_docs
rendering
What are the parameters of `Mathf.PerlinNoise` in Unity?
Returns float Value between 0.0 and 1.0. (Return value might be slightly below 0.0 or beyond 1.0.) Description Generate 2D Perlin noise. Perlin noise is a pseudo-random pattern of float values generated across a 2D plane (although the technique does generalise to three or more dimensions, this is not implemented in Uni...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_197466b8c470
unity_docs
rendering
Show me a Unity C# example demonstrating `GUI.RepeatButton`.
on the screen to use for the button. text Text to display on the button. image Texture to display on the button. content Text, image and tooltip for this button. style The style to use. If left out, the button style from the current GUISkin is used. Returns bool True when the users clicks the button. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bbbfb78973f8
unity_docs
editor
Show me a Unity C# example demonstrating `PlayerSettings.Android.disableDepthAndStencilBuffers`.
PlayerSettings.Android.disableDepthAndStencilBuffers public static bool disableDepthAndStencilBuffers ; Description Disable Depth and Stencil Buffers. ```csharp using UnityEngine; using UnityEditor; using UnityEditor.Build;public class DisableDepthAndStencilBuffersSample : MonoBehaviour { [MenuItem("Build/Dis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_71dc538c0c81
unity_docs
scripting
Explain 'Euler curve resampling' in Unity.
Rotations in 3D applications are usually represented as Quaternions or Euler angles. For the most part, Unity represents rotations as Quaternions internally; however, it’s important to have a basic understanding of rotation and orientation in Unity . When you import files containing animation that come from external so...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f2d629d202f6
unity_docs
scripting
What is `SerializedProperty.longValue` in Unity? Explain its purpose and usage.
SerializedProperty.longValue public long longValue ; Description Value of an integer property as a long. Contains a valid value when propertyType is SerializedPropertyType.Integer . Most appropriate for long properties ( SerializedPropertyNumericType.Int64 ), but can be used with all integer types of 64 bit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_df5dfc561bed
unity_docs
math
What is `UIElements.BaseListView.arraySizeFieldUssClassName` in Unity? Explain its purpose and usage.
BaseListView.arraySizeFieldUssClassName public static string arraySizeFieldUssClassName ; Description The USS class name for the size field of the ListView when show bound collection size is enabled Unity adds this USS class to the size field element in the ListView when showBoundCollectionSize is set to t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a89fa2c5b2a1
unity_docs
scripting
Show me a Unity code example for 'VisualElement'.
nts. You can use a VisualElement to group elements together and apply a common style to them. For example, you can use a VisualElement to group a label and a text field together, and then apply a common style to the VisualElement. ## Create a VisualElement You can create a VisualElement with UI Builder, UXML, or C#. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_53d6f84785b3
unity_docs
xr
Show me a Unity C# example demonstrating `Search.SearchFlags.None`.
SearchFlags.None Description No specific search options. Result will be unsorted. ```csharp using System.Collections; using System.Collections.Generic; using UnityEditor; using UnityEditor.Search; using UnityEngine; public class SearchFlags_None { [MenuItem("Examples/SearchFlags/None")] public static void Reques...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_05a2d08b5247
unity_docs
rendering
In Unity's 'Create a material variant', what is 'Create a new material variant' and how does it work?
In the Project window, right-click on a material. This material becomes the parent material. Select Create > Rendering > Material Variant . Unity gives the material variant the same name as the parent material followed by Variant .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de524a2fa783
unity_docs
audio
What is `AudioCurveRendering.AudioCurveEvaluator` in Unity? Explain its purpose and usage.
AudioCurveRendering.AudioCurveEvaluator Declaration public delegate float AudioCurveEvaluator (float x ); Parameters Parameter Description x Normalized x-position in the range [0; 1] at which the curve should be evaluated. Description Curve evaluation function used to evaluate the curve y-value and at the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2282405959c9
unity_docs
math
What is `Vector3Int.sqrMagnitude` in Unity? Explain its purpose and usage.
Vector3Int.sqrMagnitude public int sqrMagnitude ; Description Returns the squared length of this vector (Read Only). Calculating the squared magnitude instead of the magnitude is much faster. Often if you are comparing magnitudes of two vectors you can just compare their squared magnitudes. Additional resourc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_089232243e9b
unity_docs
xr
What are the parameters of `Android.Permission.ShouldShowRequestPermissionRationale` in Unity?
Returns bool The value returned by equivalent Android method. Description Check whether to display the UI explaining the reason for permission before requesting it. For more information on this method, refer to Android developer documentation . ```csharp using UnityEngine; using UnityEngine.Android;public class Request...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c532682a0bf9
unity_docs
animation
What is `AnimationState.weight` in Unity? Explain its purpose and usage.
AnimationState.weight public float weight ; Description The weight of animation. This calculates the blend weights for one curve. Weights are distributed so that the top layer gets everything. If it doesn't use the full weight then the next layer gets to distribute the remaining weights and so on. Once all weig...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_518144b89f5f
unity_docs
scripting
What is `UIElements.InspectorElement.iMGUIInspectorVariantUssClassName` in Unity? Explain its purpose and usage.
InspectorElement.iMGUIInspectorVariantUssClassName public static string iMGUIInspectorVariantUssClassName ; Description USS class name of elements of this type, when they are displayed in IMGUI inspector mode.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1ca7d67b3a0
unity_docs
xr
What is `ObjectChangeEventStream.GetUpdatePrefabInstancesEvent` in Unity? Explain its purpose and usage.
ObjectChangeEventStream.GetUpdatePrefabInstancesEvent Declaration public void GetUpdatePrefabInstancesEvent (int eventIdx , out UpdatePrefabInstancesEventArgs data ); Parameters Parameter Description eventIdx The index of the event to get the data for. data The data associated with the event. Descripti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d159604c6eab
unity_docs
physics
What is `PhysicsShapeGroup2D.GetShapeVertices` in Unity? Explain its purpose and usage.
PhysicsShapeGroup2D.GetShapeVertices Declaration public void GetShapeVertices (int shapeIndex , List<Vector2> vertices ); Parameters Parameter Description shapeIndex The index of the shape stored in the PhysicsShapeGroup2D . The shape index is zero-based with the shape group having a quantity of shapes spe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f95b067c225e
unity_docs
scripting
Show me a Unity C# example demonstrating `Search.CustomObjectIndexerAttribute.version`.
CustomObjectIndexerAttribute.version public int version ; Description Version of the custom indexer. Increment this number to have the indexer re-index the indexes. Each time you modify the code of a custom indexer, increment its version number in order to update the search indexes. ```csharp [CustomObjectIn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b9acda642b98
unity_docs
scripting
In Unity's 'Script execution order', what is 'Important considerations and limitations' and how does it work?
Execution order defined in code with [DefaultExecutionOrder] does not show in the Script Execution Order settings window. If you define an execution order for a MonoBehaviour-derived type in code with [DefaultExecutionOrder] but define a different value for the same type in the Editor’s Project settings window, Unity u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fb1ead1de75b
unity_docs
editor
In Unity's 'Autodetect plug-ins for Embedded Linux', what is 'Auto detection rules' and how does it work?
Unity automatically detects plug-ins for Embedded Linux based on the following rules: Architecture-specific folders : Place plug-ins under Assets/Plugins/EmbeddedLinux/<arch> , where <arch> is x86, x86_64, ARM, or ARM64. Unity copies them only when building an app for the respective target architecture. For example, if...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2a2a445b815
unity_docs
physics
Show me a Unity C# example demonstrating `AndroidPreferredInstallLocation`.
AndroidPreferredInstallLocation enumeration Description Options for preferred storage location for the application installation on Android devices. These options indicate whether the application should be installed on an internal or external storage of the Android device. You can pass a value from this enum to Pl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eee34e666afa
unity_docs
rendering
What is `Material.GetColor` in Unity? Explain its purpose and usage.
Material.GetColor Declaration public Color GetColor (string name ); Declaration public Color GetColor (int nameID ); Parameters Parameter Description nameID The name ID of the property retrieved by Shader.PropertyToID . name The name of the property. Description Get a named color value. Many ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5bb1f472d7b
unity_docs
rendering
What is `StreamingController.IsPreloading` in Unity? Explain its purpose and usage.
StreamingController.IsPreloading Declaration public bool IsPreloading (); Returns bool True if in a preloading state, otherwise False. Description Used to find out whether the StreamingController is currently preloading texture mipmaps.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3b503d1abeb0
unity_docs
rendering
What is `UIElements.PanelSettings.targetDisplay` in Unity? Explain its purpose and usage.
PanelSettings.targetDisplay public int targetDisplay ; Description Set the display intended for the panel. This setting is relevant only when no render texture is applied, as the renderTexture takes precedence.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0aec069eb274
unity_docs
scripting
What is `Build.OSArchitecture` in Unity? Explain its purpose and usage.
OSArchitecture enumeration Description Enum representing processor architectures that are supported by certain operating systems. Currently only used when building for standalone desktop players. Properties Property Description x64 Supported for MacOS, Windows and Linux. ARM64 Supported for MacOS and Windows....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_25f40739b5de
github
scripting
Write a Unity C# script called Pool Base
```csharp using System.Collections.Generic; using System.Linq; using UnityEngine.Pool; namespace Pool.Runtime { /// <summary> /// A base class for pooling objects of type T. This class manages the object pool, handles object creation, /// retrieval, release, and destruction, and supports initialization o...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_8766ec6ff852
unity_docs
scripting
What is `UIElements.BaseTreeViewController.GetChildrenIdsByIndex` in Unity? Explain its purpose and usage.
BaseTreeViewController.GetChildrenIdsByIndex Declaration public IEnumerable<int> GetChildrenIdsByIndex (int index ); Parameters Parameter Description index The item index. Returns IEnumerable<int> The children IDs. Description Gets the children IDs of the item with the specified index.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_edd51e49c47d
unity_docs
rendering
Show me a Unity C# example demonstrating `Material.enabledKeywords`.
An array containing the local shader keywords that are currently enabled for this material. Shader keywords determine which shader variants Unity uses. For information on working with local shader keywords and global shader keywords and how they interact, see Using shader keywords with C# scripts . This example p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_39f9289cb45a
unity_docs
scripting
In Unity's 'ProgressBar', what is 'Customize the bar' and how does it work?
To change the style of the bar, use the.unity-progress-bar__progress USS selector. For example, the following USS changes the size and the color of the bar: ```.unity-progress-bar__progress { width: 20px; height: 50px; background-color: yellow; } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4a70d00c9dfb
unity_docs
rendering
What is `Apple.ReplayKit.ReplayKit` in Unity? Explain its purpose and usage.
Method group is Obsolete ReplayKit class in UnityEngine.Apple.ReplayKit / Implemented in: UnityEngine.CoreModule Obsolete ReplayKit will be removed in future version of Unity. Description ReplayKit is only available on certain iPhone, iPad and iPod Touch devices running iOS 9.0 or later. ReplayKit allows yo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b5c7135fffe4
unity_docs
scripting
Give me an overview of the `RectOffset` class in Unity.
RectOffset class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Offsets for rectangles, borders, etc. Used all over the place by GUIStyle . Properties Property Description bottom Bottom edge size. horizontal Shortcut for left + right. (Read Only) left Left edge size. right Right edg...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_56b1488b81f7
unity_docs
scripting
What is `ShortcutManagement.KeyCombination.control` in Unity? Explain its purpose and usage.
KeyCombination.control public bool control ; Description Determines if the Control key modifier is part of the key combination. Represents the Control key on Windows, macOS, and Linux. For most cases it is best to use action as it will bind the most appropriate action key for each particular platform.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_df602325da7a
unity_docs
rendering
What is `Rendering.EditorGraphicsSettings.batchRendererGroupShaderStrippingMode` in Unity? Explain its purpose and usage.
EditorGraphicsSettings.batchRendererGroupShaderStrippingMode public static Rendering.BatchRendererGroupStrippingMode batchRendererGroupShaderStrippingMode ; Description The current mode the BatchRendererGroup stripping is set to.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_be48f6094c59
unity_docs
animation
What is `Animations.GameObjectRecorder.isRecording` in Unity? Explain its purpose and usage.
GameObjectRecorder.isRecording public bool isRecording ; Description Returns true when the recorder is recording. (Read Only) Is true after the first call of TakeSnapshot , and is reset to false when ResetRecording is called.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_01896a91c823
unity_docs
math
What are the parameters of `Graphics.RenderMeshIndirect` in Unity?
Description Renders multiple instances of a mesh using GPU instancing and rendering command arguments from commandBuffer . This function renders multiple instances of the same Mesh, similar to Graphics.RenderMeshInstanced , but takes the rendering command arguments from commandBuffer . You can set up these command argu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4bb8afa69d82
unity_docs
editor
Explain 'WinRT API in C# scripts for UWP' in Unity.
Unity includes Windows Runtime (WinRT) support when building for Universal Windows Platform with the IL2CPP scripting backend. Use Windows Runtime support to call into both native system Windows Runtime APIs as well as custom .winmd files directly from managed (C#) scripts and plugins. Unity automatically references Wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e88f5aacdcd3
unity_docs
animation
What is `AnimationUtility.SetEditorCurve` in Unity? Explain its purpose and usage.
AnimationUtility.SetEditorCurve Declaration public static void SetEditorCurve ( AnimationClip clip , EditorCurveBinding binding , AnimationCurve curve ); Parameters Parameter Description clip The animation clip to modify. binding The binding that defines the path and the properties of the curve. cu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9c91a14291c3
unity_docs
editor
What is `EditorSettings.cacheServerEnableAuth` in Unity? Explain its purpose and usage.
EditorSettings.cacheServerEnableAuth public static bool cacheServerEnableAuth ; Description Toggle whether to enable authentication to cache server. This toggles whether to use authentication when accessing the cache server.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1724f442d80c_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A brush guid and some strokesThis is the only grouping that can be converted to geometry Signature: ```csharp public class ExportBrush ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_1759b4785fc8
unity_docs
editor
Show me a Unity C# example demonstrating `EditorUtility.DisplayDialogComplex`.
play order is: ok , alt , then cancel . On macOS, the display order is: alt , cancel , then ok . Additional resources: DisplayDialog . macOS display dialog buttons for the example below. PC display dialog buttons for the example below. The script reference example below creates a complex display dialog. The ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ddc0af874071
unity_docs
editor
What is `Callbacks.RunBeforePackageAttribute.ctor` in Unity? Explain its purpose and usage.
RunBeforePackageAttribute Constructor Declaration public RunBeforePackageAttribute (string packageName ); Parameters Parameter Description packageName The name of the package that should be run after this callback. Description Add this attribute to a callback method to mark that this callback must be run b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_872a260f2357
unity_docs
input
What is `XR.XRInputSubsystem.TryGetInputDevices` in Unity? Explain its purpose and usage.
XRInputSubsystem.TryGetInputDevices Declaration public bool TryGetInputDevices (List<InputDevice> devices ); Parameters Parameter Description devices The list of devices reported by this subsystem. Returns bool True, if the XRInputSubsystem retrieves any devices. Returns false otherwise. Description...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aeeb1658956a
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R16_SInt` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R16_SInt Description A one-component, 16-bit signed integer format that has a single 16-bit R component.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6a38e4b50ce1
unity_docs
rendering
In Unity's 'How Streaming Virtual Texturing works', what is 'SVT in the High Definition Render Pipeline debug view' and how does it work?
The High Definition Render Pipeline (HDRP) debug view shows how many neighboring screen pixels request the same tile. To open the HDRP debug view, navigate to the Unity top menu and select Window > Analysis > Rendering Debugger > Rendering . To view the debug data for SVT, set Fullscreen Debug Mode to RequestedVirtualT...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f68b7947fc1d
unity_docs
performance
What is `Unity.Jobs.IJobExtensions` in Unity? Explain its purpose and usage.
IJobExtensions class in Unity.Jobs / Implemented in: UnityEngine.CoreModule Description Contains extension methods for jobs using the IJob interface. Static Methods Method Description EarlyJobInit Gathers and caches reflection data for the internal job system's managed bindings. Run Performs the job's Exe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7521cd062cca
unity_docs
editor
What are the parameters of `EditorGUILayout.FloatField` in Unity?
Returns float The value entered by the user. Description Make a text field for entering float values. Multiply the scale of the selected GameObject. ```csharp using UnityEngine; using UnityEditor;// Editor Script that multiplies the scale of the current selected GameObjectpublic class FloatFieldExample : EditorWindow {...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dae8473ddc5c
unity_docs
scripting
What is `ObjectPreview.Initialize` in Unity? Explain its purpose and usage.
ObjectPreview.Initialize Declaration public void Initialize (Object[] targets ); Parameters Parameter Description targets The objects being previewed. Description Called when the Preview gets created with the objects being previewed. You can override this function and use this to cache or initialize anyth...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dac696368ff3
unity_docs
scripting
Explain 'Unity attributes' in Unity.
Attributes in C# are metadata markers that can be placed above a class, property, or method declaration to indicate special behaviour. There are many attributes defined in the .NET libraries and Unity also provides a number of custom, Unity-specific attributes. For example, you can add the HideInInspector attribute abo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_225c86bbd4bc
unity_docs
rendering
What is `Texture2D.SetPixelData` in Unity? Explain its purpose and usage.
Texture2D.SetPixelData Declaration public void SetPixelData (T[] data , int mipLevel , int sourceDataStartIndex = 0); Declaration public void SetPixelData (NativeArray<T> data , int mipLevel , int sourceDataStartIndex = 0); Parameters Parameter Description data The array of data to use. mipLevel ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a109fa6563f9
unity_docs
scripting
What is `Progress.Item.elapsedTime` in Unity? Explain its purpose and usage.
Progress.Item.elapsedTime public float elapsedTime ; Description Returns the number of seconds that the progress indicator has been running for. Additional resources: Progress.GetStartDateTime , Progress.Item.startTime .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2eea420a3270
unity_docs
math
What is `XR.XRDisplaySubsystem.XRRenderPass.spaceWarpRightHandedNDC` in Unity? Explain its purpose and usage.
XRDisplaySubsystem.XRRenderPass.spaceWarpRightHandedNDC public bool spaceWarpRightHandedNDC ; Description When true , the SpaceWarp motion vector data is in the right-handed normalized device coordinate (NDC) space. When false , the motion vector data is in the left-handed NDC space.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3c40adbd30d4
unity_docs
rendering
Show me a Unity C# example demonstrating `Screen.SetMSAASamples`.
gs and Unity may allocate a MSAA render target that is not needed since your render pipeline already resolves as part of its post-processing. See also: SystemInfo.supportsMultisampledBackBuffer , msaaSamples The example demonstrates how a render pipeline might use this function in combination with its own MSAA settin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_580261ac2cfd
unity_docs
editor
What is `iOS.Xcode.PBXProject.AddSourcesBuildPhase` in Unity? Explain its purpose and usage.
PBXProject.AddSourcesBuildPhase Declaration public string AddSourcesBuildPhase (string targetGuid ); Parameters Parameter Description targetGuid The GUID of the target, such as the one returned by TargetGuidByName . Returns string Returns the GUID of the new phase. Description Creates a new sources ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cc71f0e9337d
unity_docs
animation
What is `UIElements.Experimental.ValueAnimation_1.Ease` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ValueAnimation<T0>.Ease Declaration public ValueAnimation<T> Ease (Func<float,float> easing ); Description Sets the easing function.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0b5150b41c63
unity_docs
rendering
What is `TextureImporter.normalmapFilter` in Unity? Explain its purpose and usage.
TextureImporter.normalmapFilter public TextureImporterNormalFilter normalmapFilter ; Description Normal map filtering mode. Additional resources: TextureImporterNormalFilter , convertToNormalmap .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3a5944096c47
unity_docs
editor
Explain 'Cache Server Project Settings reference' in Unity.
You can adjust how Unity Accelerator works with the Cache Server Project Settings. To open the Cache Server settings go to Edit > Project Settings > Editor > Accelerator Cache Server Setting Description Mode Choose whether to use the cache server. Choose from the following options: Use global settings: Uses the setting...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_946c464b65d2
unity_docs
scripting
What is `Unity.IO.LowLevel.Unsafe.ReadHandle.Cancel` in Unity? Explain its purpose and usage.
ReadHandle.Cancel Declaration public void Cancel (); Description Cancels the AsyncReadManager.Read operation on this handle. If the read operation has already begun, the operation still completes. Only operations waiting in the queue can be canceled.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8c96bd0f9f6c
unity_docs
scripting
What is `KeyCode.Return` in Unity? Explain its purpose and usage.
KeyCode.Return Description Return key. The key used to accept a line of text. osMac calls this Return . A PC calls this Enter . There is no KeyCode.Enter . On a PC use Return . Some laptops have no name on the Return or Enter key. ```csharp // KeyCode.Return example. // // Attach this to a GameObject. // T...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ced733dbaaa3
unity_docs
math
What are the parameters of `Mesh.SetIndexBufferParams` in Unity?
Description Sets the index buffer size and format. Note: This method is designed for advanced users aiming for maximum performance because it operates on the underlying mesh data structures that primarily work on raw index buffers, vertex buffers and mesh subset data. Using this method, Unity performs very little data ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_08aafd0686f5
unity_docs
rendering
What is `MaterialEditor.kMiniTextureFieldLabelIndentLevel` in Unity? Explain its purpose and usage.
MaterialEditor.kMiniTextureFieldLabelIndentLevel public static int kMiniTextureFieldLabelIndentLevel ; Description Useful for indenting shader properties that need the same indent as mini texture field.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_96af48978eaf
unity_docs
rendering
Explain 'Apply default presets to assets by folder' in Unity.
For large projects, you might use several presets for importing the same type of asset. For example, you might have a preset for importing default textures and another for lightmap textures. You can have separate subfolders in the Assets folder for each texture type and each subfolder can have its own preset that appli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4264dd3ba4de
unity_docs
scripting
What is `UIElements.UxmlAssetAttributeDescription_1.TryGetValueFromBag` in Unity? Explain its purpose and usage.
UxmlAssetAttributeDescription<T0>.TryGetValueFromBag Declaration public bool TryGetValueFromBag ( UIElements.IUxmlAttributes bag , UIElements.CreationContext cc , out T value ); Parameters Parameter Description bag The bag of attributes. cc The context in which the values are retrieved. value The va...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5c3658b22052
unity_docs
performance
What is `Profiling.Recorder.Get` in Unity? Explain its purpose and usage.
Recorder.Get Declaration public static Profiling.Recorder Get (string samplerName ); Parameters Parameter Description samplerName Sampler name. Returns Recorder Recorder object for the specified Sampler. Description Use this function to get a Recorder for the specific Profiler label. ```csharp usi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_240faa0fe08c
unity_docs
physics
What is `Physics.queriesHitTriggers` in Unity? Explain its purpose and usage.
Physics.queriesHitTriggers public static bool queriesHitTriggers ; Description Specifies whether queries (raycasts, spherecasts, overlap tests, etc.) hit Triggers by default. This can be overridden on a per-query level by specifying the QueryTriggerInteraction parameter. Additional resources: Physics.Raycast .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0884500278ec
unity_docs
rendering
Show me a Unity C# example demonstrating `PlayerSettings.Android.applicationEntry`.
nEntry public static AndroidApplicationEntry applicationEntry ; Description Application entry classes to include. Note: You can specify multiple application entries for development purposes, this will cause two application icons to appear on Android device. You should always specify a single entry when pub...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ad8331cad218
unity_docs
scripting
What is `WeightedMode` in Unity? Explain its purpose and usage.
WeightedMode enumeration Description Sets which weights to use when calculating curve segments. Additional resources: Keyframe.weightedMode , Keyframe.inWeight , Keyframe.outWeight . Properties Property Description None Exclude both inWeight or outWeight when calculating curve segments. In Include inWeight...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de10d0434d7a
unity_docs
rendering
What is `Rendering.ShadowDrawingSettings.ctor` in Unity? Explain its purpose and usage.
ShadowDrawingSettings Constructor Obsolete ShadowDrawingSettings(CullingResults, int, BatchCullingProjectionType) is deprecated. Use ShadowDrawingSettings(CullingResults, int) instead. Declaration public ShadowDrawingSettings ( Rendering.CullingResults cullingResults , int lightIndex , Rendering.BatchCullingP...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_add4e7b14cd7
unity_docs
rendering
What is `ParticleSystemRenderer.allowRoll` in Unity? Explain its purpose and usage.
ParticleSystemRenderer.allowRoll public bool allowRoll ; Description Allow billboard particles to roll around their z-axis. Allows billboards to roll with the Camera. It is often useful to disable this option when using VR, to give particles a more believable grounding in the world. ```csharp using UnityEngine...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d5e9b909013f
unity_docs
rendering
In Unity's 'Introduction to 2D texture arrays', what is 'Platform support' and how does it work?
Texture arrays are supported if the platform supports one of the following graphics APIs: DirectX11 and DirectX12 (Windows) Metal (iOS, macOS) OpenGL Core (macOS, Linux) OpenGL ES 3.0 (Android, WebGL 2.0) Vulkan (Windows, Linux) To check if a platform supports texture arrays, use the SystemInfo.supports2DArrayTextures ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7d4e4c2669dc
unity_docs
scripting
What is `UIElements.Toolbar` in Unity? Explain its purpose and usage.
Toolbar class in UnityEditor.UIElements / Inherits from: UIElements.VisualElement Description A toolbar for tool windows. For more information, refer to UXML element Toolbar . Static Properties Property Description ussClassName USS class name of elements of this type. Constructors Constructor Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0ec95364d196
unity_docs
scripting
What is `Networking.PlayerConnection.PlayerConnection` in Unity? Explain its purpose and usage.
PlayerConnection class in UnityEngine.Networking.PlayerConnection / Inherits from: ScriptableObject / Implemented in: UnityEngine.CoreModule Implements interfaces: IEditorPlayerConnection Description Used for handling the network connection from the Player to the Editor. Sets up events for connecting to and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_105c2a2c2ed3
unity_docs
scripting
What is `Search.SearchMonitor.documentsInvalidated` in Unity? Explain its purpose and usage.
SearchMonitor.documentsInvalidated Parameters Parameter Description value Handler invoked when documents get invalidated. Description Event raised when documents get invalidated. A document can be an asset, a scene object or anything else that can be displayed in the search view.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_54fa1e63dfff
unity_docs
scripting
What is `UIElements.BaseVerticalCollectionView.itemAlternativeBackgroundUssClassName` in Unity? Explain its purpose and usage.
BaseVerticalCollectionView.itemAlternativeBackgroundUssClassName public static string itemAlternativeBackgroundUssClassName ; Description The USS class name for odd rows in the BaseVerticalCollectionView. Unity adds this USS class to every odd-numbered item in the BaseVerticalCollectionView when the BaseV...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_499a52ef9a06
unity_docs
ui
What is `UIElements.MeshGenerationContext.DrawText` in Unity? Explain its purpose and usage.
MeshGenerationContext.DrawText Declaration public void DrawText (string text , Vector2 pos , float fontSize , Color color , TextCore.Text.FontAsset font ); Parameters Parameter Description text The text to display. pos The start position where the text will be displayed. fontSize The font size ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bd9063d09418
unity_docs
scripting
In Unity's 'Programming with gizmos and handles', what is 'Gizmos' and how does it work?
The Gizmos class allows you to draw lines, spheres, cubes, icons, textures and meshes into the Scene view to use as debugging, set-up aids, or tools while developing your project. The following example draws a 10 unit yellow wire cube around a GameObject : ```csharp using UnityEngine; public class GizmosExample : MonoB...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f377d9549d64
unity_docs
scripting
What is `AI.NavMesh.RemoveSettings` in Unity? Explain its purpose and usage.
NavMesh.RemoveSettings Declaration public static void RemoveSettings (int agentTypeID ); Parameters Parameter Description agentTypeID The ID of the entry to remove. Description Removes the build settings matching the agent type ID. If no matching settings are found or the agentTypeID is the default value ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d5db36c280a7
unity_docs
performance
What is `ParticleSystemJobs.ParticleSystemJobData.sizes` in Unity? Explain its purpose and usage.
ParticleSystemJobData.sizes public ParticleSystemJobs.ParticleSystemNativeArray3 sizes ; Description The size of each particle. When using 3D sizes, all three axes contain data, otherwise only the x-axis contains size data, and Unity applies it uniformly to each axis.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ad29a311c7ab
unity_docs
rendering
In Unity's 'Add ambient light from the environment', what is 'Add ambient light' and how does it work?
After you create a skybox material , Unity can use it to generate ambient lighting in your Scene. To make Unity do this: Open the Lighting window (menu: Window > Rendering > Lighting ). Select the Environment tab. Assign your chosen skybox to the Skybox Material property. Click the Source drop-down and, from the list, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4ccc05cad3fd
unity_docs
scripting
What is `Application.absoluteURL` in Unity? Explain its purpose and usage.
Application.absoluteURL public static string absoluteURL ; Description The URL of the document. For WebGL, this is a web URL. For Android, iOS, or Universal Windows Platform (UWP) this is a deep link URL (Read Only). WebGL : The URL of the document as shown in a browser's address bar. Android: If the applicati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_107f7c4bf0ba
github
scripting
Write a Unity C# script called Random Colors
```csharp using System.Collections; using UnityEngine; using Unity.MaterialPropertyProvider; public class RandomColors : MaterialPropertyProviderBase { [SerializeField] private float _frequency = 3f; [SerializeField] AnimationCurve _lerpCurve = new AnimationCurve(new Keyframe[2] { new Keyframe(0, 0, 0, 0), new...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_b1eacd29a20f
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUILayout.EndToggleGroup`.
EditorGUILayout.EndToggleGroup Declaration public static void EndToggleGroup (); Description Close a group started with BeginToggleGroup . Additional resources: BeginToggleGroup Align position/rotation/scale of the selected GameObjects. ```csharp // Simple script that lets you align GameObjects // position/...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_beab5ca10de4
unity_docs
scripting
Show me a Unity C# example demonstrating `Camera.ScreenToWorldPoint`.
stem at the very top of your game's hierarchy. World space coordinates can still be calculated even when provided as an off-screen coordinate, for example for instantiating an off-screen object near a specific corner of the screen. To make sure the world space point is part of the camera's view volume, the z coordinat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2e15464b91f9
unity_docs
scripting
What is `SceneView.lastActiveSceneViewChanged` in Unity? Explain its purpose and usage.
SceneView.lastActiveSceneViewChanged public static Action<SceneView,SceneView> lastActiveSceneViewChanged ; Description Register to this callback to get notified when the active Scene View changes. The callback will be called with a reference to the previously active Scene View and the newly active Scene View.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_812ea434c443
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.RGBA_ASTC5X5_UNorm` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.RGBA_ASTC5X5_UNorm Description A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 5×5 rectangle of unsigned normalized RGBA texel data.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_237b8de545e7
unity_docs
scripting
What is `UIElements.CurveField.ranges` in Unity? Explain its purpose and usage.
CurveField.ranges public Rect ranges ; Description Optional rectangle that the curve is restrained within. If the range width or height is < 0 then CurveField computes an automatic range, which encompasses the whole curve.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dfff8c02a775
unity_docs
rendering
What are the parameters of `ComputeShader.SetKeyword` in Unity?
Description Sets the state of a local shader keyword for this compute shader. Shader keywords determine which shader variants Unity uses. For information on working with local shader keywords and global shader keywords and how they interact, see Using shader keywords with C# scripts . When value is true , this function...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_654d1bbc2e86
unity_docs
rendering
What is `MaterialEditor` in Unity? Explain its purpose and usage.
MaterialEditor class in UnityEditor / Inherits from: Editor Description The Unity Material Editor. Extend this class to write your own custom material editor. For more detailed information see the Custom Material Editor section of the ShaderLab reference . Static Properties Property Description kMiniText...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.