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_4c8dc6cb6d69
unity_docs
scripting
What is `Hash128.ToString` in Unity? Explain its purpose and usage.
Hash128.ToString Declaration public string ToString (); Description Convert a Hash128 to string. This creates a string that is 32 characters long. Each of the 16 hash bytes is represented as two hexadecimal characters. ```csharp using UnityEngine;public class ExampleScript : MonoBehaviour { void Start() { v...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ad65debc5da7
unity_docs
physics
What is `ContactPair` in Unity? Explain its purpose and usage.
ContactPair struct in UnityEngine / Implemented in: UnityEngine.PhysicsModule Description A pair of Colliders that belong to the bodies in the parent ContactPairHeader struct. Contains an array of ContactPairPoint s that can be retrieved using the GetContactPoint method. Properties Property Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5db7b51ec564
unity_docs
scripting
Show me a Unity C# example demonstrating `GUIStyleState.textColor`.
GUIStyleState.textColor public Color textColor ; Description The text color used by GUI elements in this state. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Sets the text color to yellow of customStyles[0] when an // element is turned on and pressed down void OnGUI() { if (GUI.sk...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3bea9262c312
unity_docs
scripting
What is `AndroidJNI.NewGlobalRef` in Unity? Explain its purpose and usage.
AndroidJNI.NewGlobalRef Declaration public static IntPtr NewGlobalRef (IntPtr obj ); Description Creates a new global reference to the object referred to by the obj argument. 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.
gh_4c1f3cd1bbd2_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The View handles user interface and user inputRelates to the Signature: ```csharp public class GameView: MonoBehaviour, IView ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_f415bd4cd063
unity_docs
scripting
Show me a Unity C# example demonstrating `Video.VideoClip.length`.
th of the video clip in seconds. (Read Only). You can use this property to ensure any events, sounds, visual effects, logic etc. you want to trigger during the video happen within the time limits of the video. Note : The VideoClip can return an inaccurate length because the external encoder can be imprecise. Use Vid...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_52f7a2abd5b1
unity_docs
rendering
What is `Lightmapping.SetLightingDataAssetForScene` in Unity? Explain its purpose and usage.
Lightmapping.SetLightingDataAssetForScene Declaration public static void SetLightingDataAssetForScene ( SceneManagement.Scene scene , LightingDataAsset lda ); Parameters Parameter Description scene The scene to set the LightingDataAsset for. lda The LightingDataAsset to associate with the scene. Descr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6017d49c5f16
unity_docs
networking
In Unity's 'Use the Multiplayer Center', what is 'Install recommended packages' and how does it work?
To install the packages that the Multiplayer Center recommends, select Install Packages . Unity then installs these packages and their dependencies in your project and automatically opens the Quickstart tab. To remove a package from the install process, deselect the checkbox next to the package name before you select I...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ab5ae5fbabef
unity_docs
animation
In Unity's 'Performance and optimization', what is 'Scale curves' and how does it work?
Animating scale curves is more expensive than animating translation and rotation curves. To improve performance, avoid scale animations. Note: This does not apply to constant curves (curves that have the same value for the length of the animation clip ). Constant curves are optimized, and are less expensive than normal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f8becb8645d
unity_docs
ui
Show me a Unity C# example demonstrating `GUISkin.scrollView`.
GUISkin.scrollView public GUIStyle scrollView ; Description Style used by default for the background of ScrollView controls (see GUI.BeginScrollView ). ```csharp using UnityEngine;public class Example : MonoBehaviour { // Modifies only the background of the ScrollView controls // of the current GUISkin. V...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca8d7caeb099
unity_docs
physics
What is `Physics2D.minSubStepFPS` in Unity? Explain its purpose and usage.
Physics2D.minSubStepFPS public static float minSubStepFPS ; Description The minimum FPS allowed for a simulation step before sub-stepping will be used. When simulation sub-stepping is enabled with Physics2D.useSubStepping , this property is used as a FPS threshold below which simulation sub-stepping will occur...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e3472f4fbc45
unity_docs
editor
What is `ProfilerWindow.selectedModuleIdentifier` in Unity? Explain its purpose and usage.
ProfilerWindow.selectedModuleIdentifier public string selectedModuleIdentifier ; Description The identifier of the Profiler module that is currently selected in the Profiler Window, or null if no Module is currently selected. The Profiler Window shows the Module Details panel in its bottom half for the curr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fafecd537b16
unity_docs
math
Show me a Unity C# example demonstrating `Plane.GetSide`.
Plane.GetSide Declaration public bool GetSide ( Vector3 point ); Description Is a point on the positive side of the plane? ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { public Plane goalLine1; public Plane goalLine2; public Plane leftSideLine; public Pla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_afedcce37577
unity_docs
scripting
What is `ApiCompatibilityLevel` in Unity? Explain its purpose and usage.
ApiCompatibilityLevel enumeration Description .NET API compatibility level. Properties Property Description NET_2_0.NET 2.0. NET_2_0_Subset.NET 2.0 Subset. NET_4_6 Deprecated, use ApiCompatibilityLevel.NET_Unity_4_8 instead. NET_Web Web profile, formerly used only by Samsung TV. NET_Micro Micro profile, use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_24d1d679aaab
unity_docs
scripting
What is `ParticleSystem.colorOverLifetime` in Unity? Explain its purpose and usage.
ParticleSystem.colorOverLifetime public ParticleSystem.ColorOverLifetimeModule colorOverLifetime ; Description Script interface for the ColorOverLifetimeModule of a Particle System. This module changes the colors assigned to particles over time, based on how long each particle has been alive. Particle System...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ea5cbde79d95
unity_docs
xr
What is `CharacterInfo` in Unity? Explain its purpose and usage.
CharacterInfo struct in UnityEngine / Implemented in: UnityEngine.TextRenderingModule Description Specification for how to render a character from the font texture. See Font.characterInfo . Additional resources: Example at Font.RequestCharactersInTexture . Properties Property Description advance The horiz...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cb4a61ddee0b
unity_docs
scripting
In Unity's 'ToolbarSpacer', what is 'Inherited UXML attributes' and how does it work?
This element inherits the following attributes from its base class: Name Type Description focusable boolean If false, this prevents the element from being focused. The element can only be focused if its canGrabFocus property is true. tabindex int An integer used to sort focusable elements in the focus ring. Must be gre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ea96d91b4321
unity_docs
scripting
In Unity's 'Horizontal Layout Group', what is 'Properties' and how does it work?
Property: Function: Padding The padding inside the edges of the layout group. Spacing The spacing between the layout elements. Child Alignment The alignment to use for the child layout elements if they don't fill out all the available space. Control Child Size Whether the Layout Group controls the width and height of i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_56ccd830fd82
unity_docs
scripting
Show me a Unity C# example demonstrating `SystemInfo.graphicsDeviceName`.
SystemInfo.graphicsDeviceName public static string graphicsDeviceName ; Description The name of the graphics device (Read Only). This is the name of user's graphics card, as reported by the graphics driver. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { // Prints using the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ccafad6a6e9
unity_docs
editor
What is `Build.Content.AssetLoadInfo` in Unity? Explain its purpose and usage.
AssetLoadInfo class in UnityEditor.Build.Content Description Container for holding preload information for a given serialized Asset. Note: this class and its members exist to provide low-level support for the Scriptable Build Pipeline package. This is intended for internal use only; use the Scriptable Build Pi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc34dacbbde8
unity_docs
networking
What is `Networking.MultipartFormFileSection.contentType` in Unity? Explain its purpose and usage.
MultipartFormFileSection.contentType public string contentType ; Returns string The Content-Type header for this section, or null . Description Returns the value of the section's Content-Type header. Additional resources: [IMultipartFormSection.contentType].
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aff361e01aa6
unity_docs
math
What are the parameters of `Mathf.InverseLerp` in Unity?
Returns float A value between zero and one, representing where the "value" parameter falls within the range defined by a and b. Description Determines where a value lies between two points. The a and b values define the start and end of a linear numeric range. The "value" parameter you supply represents a value which m...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_27cb4bb4b812
unity_docs
ui
Explain 'Runtime UI event system and input handling' in Unity.
UI Toolkit uses an event system to handle input and send events to all active panels. This system processes input events and sends them to the appropriate elements in the UI. ## Use UI Toolkit with different input systems Unity provides two input handling systems: the legacy Input Manager and the new Input System pac...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_62528bc21873
unity_docs
scripting
What is `ParticleSystem.rotationBySpeed` in Unity? Explain its purpose and usage.
ParticleSystem.rotationBySpeed public ParticleSystem.RotationBySpeedModule rotationBySpeed ; Description Script interface for the RotationBySpeedModule of a Particle System. Rotate particles based on their speed. Particle System modules do not need to be reassigned back to the system; they are interfaces and...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cdc867a74e1b
unity_docs
scripting
Show me a Unity C# example demonstrating `EditorTools.EditorToolContext`.
EditorToolContext class in UnityEditor.EditorTools / Inherits from: ScriptableObject Description Use this class to implement specialized versions of the built-in transform tools. Built-in transform tools include Move, Rotate, Scale, Rect, and Transform. ```csharp using System; using System.Collections.Generic; ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e39c775e2fec
unity_docs
rendering
What is `ReflectionProbe.mode` in Unity? Explain its purpose and usage.
ReflectionProbe.mode public Rendering.ReflectionProbeMode mode ; Description Should reflection probe texture be generated in the Editor ( ReflectionProbeMode.Baked ) or should probe use custom specified texure ( ReflectionProbeMode.Custom )? Additional resources: ReflectionProbeMode .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_62c5b900013e
unity_docs
scripting
What is `Search.SearchUtils.FormatBytes` in Unity? Explain its purpose and usage.
SearchUtils.FormatBytes Declaration public static string FormatBytes (long byteCount ); Parameters Parameter Description byteCount Byte count. Returns string Formatted string. Description Formats a number into a file size in bytes string. This function is used by the search asset provider to format ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_711bdd565249
unity_docs
physics
What is `Collision.body` in Unity? Explain its purpose and usage.
Collision.body public Component body ; Description The Rigidbody or ArticulationBody of the collider that your Component collides with (Read Only). This returns the Rigidbody or ArticulationBody of the collider that your Component collides with. If the collider doesn't have a rigid or articulation...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c88da16fac94
unity_docs
math
What is `Rendering.CullingSplit` in Unity? Explain its purpose and usage.
CullingSplit struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description This struct contains the properties of a culling split. Properties Property Description cascadeBlendCullingFactor Cascade blend culling factor. cullingMatrix Culling matrix. cullingPlaneCount The number of cul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d3125414e349
unity_docs
scripting
What is `UIElements.AlternatingRowBackground` in Unity? Explain its purpose and usage.
AlternatingRowBackground enumeration Description Options to display alternating background colors for collection view rows. If there are more rows with content than there are visible rows, you will not see a difference between the All option and the ContentOnly option. Properties Property Description...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b7108e906ebe
unity_docs
math
Show me a Unity C# example demonstrating `Mesh.GetBonesPerVertex`.
ive array. However the native array points to memory that might be deallocated or reallocated, so you should either call GetBonesPerVertex every frame to get the correct data, or check the native array is still valid each frame. Additional resources: Mesh.GetAllBoneWeights , Mesh.SetBoneWeights , ModelImporter.max...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_03c81ffff22e
unity_docs
scripting
What is `Build.Content.ContentBuildInterface.WriteGameManagersSerializedFile` in Unity? Explain its purpose and usage.
ContentBuildInterface.WriteGameManagersSerializedFile Declaration public static Build.Content.WriteResult WriteGameManagersSerializedFile (string outputFolder , Build.Content.WriteManagerParameters parameters ); Parameters Parameter Description outputFolder The location to write the file to. parameters...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db8d48721fd0
unity_docs
rendering
What is `SystemInfo.maxComputeWorkGroupSizeY` in Unity? Explain its purpose and usage.
SystemInfo.maxComputeWorkGroupSizeY public static int maxComputeWorkGroupSizeY ; Description The maximum number of work groups that a compute shader can use in Y dimension (Read Only). This is the largest number of work groups (in Y dimension) that a compute shader on the current device can use.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8b7e480a27be
unity_docs
rendering
Explain 'HLSL pragma directives reference' in Unity.
## Standard pragma directives Unity supports all #pragma directives that are part of standard HLSL, as long as these directives are in regular include files. For more information on these directives, see the HLSL documentation: pragma Directive . ## Surface Shaders If you are writing a Surface Shader , use this dire...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5ca955c05f2d
unity_docs
editor
What is `Toolbars.EditorToolbarDropdownToggle.SetValueWithoutNotify` in Unity? Explain its purpose and usage.
EditorToolbarDropdownToggle.SetValueWithoutNotify Declaration public void SetValueWithoutNotify (bool newValue ); Description Allow to set a value without being notified of the change, if any.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fa4d4ab65975
unity_docs
ui
What is `UIElements.Binding.OnDeactivated` in Unity? Explain its purpose and usage.
Binding.OnDeactivated(BindingActivationContext) Parameters Parameter Description context Context object. Description Called when the binding is no longer active for a specific VisualElement .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e28789357f0a
unity_docs
editor
What is `Unity.Profiling.Editor.ProfilerModuleMetadataAttribute` in Unity? Explain its purpose and usage.
ProfilerModuleMetadataAttribute class in Unity.Profiling.Editor Description Provides metadata related to a ProfilerModule , such as its name and icon path. You must attribute a ProfilerModule derived type with ProfilerModuleMetadataAttribute for Unity to display it in the Profiler window. ```csharp using Sy...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3b4d4dd9eb31
unity_docs
xr
What is `SearchService.AdvancedObjectSelectorEventType` in Unity? Explain its purpose and usage.
AdvancedObjectSelectorEventType enumeration Description Enum that defines the type of events that are possible when calling a custom advanced object selector. Properties Property Description BeginSession This event means that we are beginning a search session. EndSession This event means that the search sessio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_103347a59c12_doc_2
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Stores the used to set the move speed of continuous movement. Signature: ```csharp public Slider moveSpeedSlider ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_255c208033cc
unity_docs
performance
What is `Unity.Profiling.ProfilerRecorder.LastValue` in Unity? Explain its purpose and usage.
ProfilerRecorder.LastValue public long LastValue ; Description Gets the last value collected by the ProfilerRecorder. Use to get the profiler counter value or marker timing capured at the end of the last frame. The immediate value that CurrentValue provides might be not the final value of a counter when frame...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5ae2baa23a43
unity_docs
editor
Show me a Unity C# example demonstrating `StaticEditorFlags.OccludeeStatic`.
StaticEditorFlags.OccludeeStatic Description Mark the GameObject as a Static Occludee in the occlusion culling system. For more information, see the documentation on the Occlusion Culling system . ```csharp using UnityEngine; using UnityEditor; public class StaticEditorFlagsExample { [MenuItem("Examples/Create G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5ae4787bbb35
unity_docs
physics
Give me an overview of the `SpherecastCommand` class in Unity.
SpherecastCommand struct in UnityEngine / Implemented in: UnityEngine.PhysicsModule Description Use this struct to set up a sphere cast command that is performed asynchronously during a job. When you use this struct to schedule a batch of sphere casts, the sphere casts are performed asynchronously and in parall...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1de0efeef0e7
unity_docs
editor
Show me a Unity C# example demonstrating `SceneManagement.EditorSceneManager.NewScene`.
Description Create a new Scene. The setup parameter allows you to select whether or not the default set of GameObjects should be added to the new Scene. See NewSceneSetup for more information about the options. The mode parameter allows you to select how to open the new Scene, and whether to keep existing Scenes in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d472ab1874fb
unity_docs
input
What is `AndroidGamepadSupportLevel` in Unity? Explain its purpose and usage.
AndroidGamepadSupportLevel enumeration Description Gamepad support level for Android TV. Properties Property Description SupportsDPad Game is fully operational with a D-pad, no gamepad needed. SupportsGamepad Works with a gamepad, but does not require it. RequiresGamepad Requires a gamepad for gameplay.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d25f9f40cf3d
unity_docs
editor
What is `Experimental.GraphView.ICollectibleElement` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ICollectibleElement interface in UnityEditor.Experimental.GraphView Description CollectibleElement interface. Public Methods Method Description CollectElements Retrieves a set of graph elements that match a specified condit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca9701175642
unity_docs
scripting
What is `AndroidJNI.GetBooleanField` in Unity? Explain its purpose and usage.
AndroidJNI.GetBooleanField Declaration public static bool GetBooleanField (IntPtr obj , IntPtr fieldID ); Description Returns the value of an instance (nonstatic) field of an 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.
gh_5fa5b2bb33d7
github
scripting
Write a Unity C# script called Tile Style
```csharp using System; using System.Collections.Generic; using UnityEngine; namespace BehaviourInject.Example { public class TileStyle : IDisposable { public Color StyleColor { get; private set; } public string Name { get; private set; } public TileStyle(Color color, string name) { StyleColor = color; ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_46ed01c90d6e
unity_docs
scripting
What is `Assertions.Assert.IsFalse` in Unity? Explain its purpose and usage.
Assert.IsFalse Declaration public static void IsFalse (bool condition ); Declaration public static void IsFalse (bool condition , string message ); Parameters Parameter Description condition true or false . message The string used to describe the result of the Assert . Description Return true ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc59a44c011e
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.RGBA_ASTC12X12_UFloat` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.RGBA_ASTC12X12_UFloat Description A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 12×12 rectangle of float RGBA texel data.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_84e6587c9d3b
unity_docs
scripting
What are the parameters of `Component.GetComponentInChildren` in Unity?
Returns T A Component of the matching type T , otherwise null if no Component is found. Description Gets a reference to a component of type T on the same GameObject as the component specified, or any child of the GameObject. The typical usage for this method is to call it from a MonoBehaviour script (which itself is a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e643db5537c7
unity_docs
scripting
What is `Experimental.GraphView.Group.FocusTitleTextField` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Group.FocusTitleTextField Declaration public void FocusTitleTextField (); Description Focuses the title text field of this group, so that it's editable from the UI.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fdcc782be00f
unity_docs
rendering
What is `Rendering.BatchRendererGroup` in Unity? Explain its purpose and usage.
BatchRendererGroup class in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description A BatchRendererGroup is an object that lets you perform customizable high performance rendering. You can set up batches in advance to set up groups of instances with shared metadata values that describe how ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7fb4ffec1ddb
unity_docs
audio
Show me a Unity C# example demonstrating `AudioLowPassFilter.cutoffFrequency`.
AudioLowPassFilter.cutoffFrequency public float cutoffFrequency ; Description Lowpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0. Note that setting this value will reset any custom cutoff curve set for this AudioLowPassFilter. ```csharp using UnityEngine;[RequireComponent(typeof(AudioSource))] ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_40ef49822954
unity_docs
rendering
What is `Rendering.CameraEvent` in Unity? Explain its purpose and usage.
CameraEvent enumeration Description Defines a place in camera's rendering to attach CommandBuffer objects to. Unity's rendering loop can be extended by adding so called "command buffers" at various points in camera rendering. For example, you could add some custom geometry to be drawn right after the skybox is d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c88e40aad7e
unity_docs
rendering
What is `Experimental.Rendering.DefaultFormat.Shadow` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. DefaultFormat.Shadow Description Represents the default platform specific shadow format. To create a RenderTexture that can be used as a shadow map, you also need to set the ShadowSamplingMode using RenderTextureDescriptor....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4118487bdc10
unity_docs
scripting
What is `Component.GetComponents` in Unity? Explain its purpose and usage.
Component.GetComponents Declaration public T[] GetComponents (); Returns T[] An array containing all matching components of type T . Description Gets references to all components of type T on the same GameObject as the component specified. The typical usage for this method is to call it from a MonoBeha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2cd4b186ea95
unity_docs
rendering
What is `Rendering.BatchFilterSettings.rendererPriority` in Unity? Explain its purpose and usage.
BatchFilterSettings.rendererPriority public int rendererPriority ; Description The sorting priority to use for draw commands in this draw range. This corresponds to Renderer.rendererPriority and allows you to control the rendering order of draw commands. Lower values are rendered first and higher values are r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f1fa36ede680
unity_docs
xr
In Unity's 'Platform development', what is 'Additional resources and examples' and how does it work?
💡 Resources : Target platforms roadmap 👥 Community : Join the conversation on Unity Discussions for Platforms 📖 E-Book : Create virtual and mixed reality experiences in Unity 📖 E-Book : Optimize your game performance for mobile, XR, and Web in Unity (Unity 6) 📖 E-Book : Optimize your game performance for consoles ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_79f880bd9322
unity_docs
scripting
Show me a Unity C# example demonstrating `Video.VideoTimeUpdateMode`.
VideoTimeUpdateMode enumeration Description Defines the time source the VideoPlayer uses to update the timing of the video playback. Use these settings to synchronize your video with audio, gameplay scaled time or unscaled time. ```csharp // This script switches between the time update modes when you press the Sp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6abdbf659a8
unity_docs
physics
What are the parameters of `MonoBehaviour.OnTriggerStay2D` in Unity?
Description Sent once per physics update when another object is within a trigger collider attached to this object (2D physics only). Further information about the other collider is reported in the Collider2D parameter passed during the call. Note: Trigger events will be sent to disabled MonoBehaviours, to allow enablin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a562952ef9c9
unity_docs
editor
Show me a Unity C# example demonstrating `Search.ISearchView.displayMode`.
ISearchView.displayMode public Search.DisplayMode displayMode ; Description Indicates how the data is displayed in the UI. . ```csharp using UnityEngine; using UnityEditor; using UnityEditor.Search; static class Example_ISearchView_displayMode { [MenuItem("Examples/ISearchView/displayMode")] public static...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_08590d2fb15f
unity_docs
editor
What is `Search.SearchSelectorArgs` in Unity? Explain its purpose and usage.
SearchSelectorArgs struct in UnityEditor.Search Description Search selector arguments used when the search selector callback is invoked. Properties Property Description current Current search item for which a value must be selected.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d29e327f7cb8
unity_docs
editor
What is `ConvertToPrefabInstanceSettings` in Unity? Explain its purpose and usage.
ConvertToPrefabInstanceSettings class in UnityEditor Description Settings controlling the behavior of PrefabUtility.ConvertToPrefabInstance . Properties Property Description changeRootNameToAssetName Change the name of the root GameObject to match the name of the Prefab Asset used when converting. components...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9947e034c59d
unity_docs
networking
Explain 'Web' in Unity.
Unity provides support for developing games on the Web platform. WebGL lets you publish real-time interactive 3d graphics into a browser. For information on getting started with a Web application, refer to the following sections: Page Description Introduction Introduction to Web development in Unity Web development Web...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e89886d01356
unity_docs
input
What is `Experimental.GraphView.Dragger.OnMouseUp` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Dragger.OnMouseUp Declaration protected void OnMouseUp ( UIElements.MouseUpEvent e ); Parameters Parameter Description e The event. Description Called on mouse up event.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c99884cfa123
unity_docs
scripting
What is `HideFlags.HideInHierarchy` in Unity? Explain its purpose and usage.
HideFlags.HideInHierarchy Description The object will not appear in the hierarchy. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Creates 5 planes and hides them from the Hierarchy in the Editor. void Start() { for (int i = 0; i < 5; i++) { GameObject createdGO = GameObject.CreatePrimiti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_91c213c21e2b
unity_docs
rendering
Show me a Unity C# example demonstrating `EditorGUIUtility.GetIconForObject`.
ure2D GetIconForObject ( Object obj ); Parameters Parameter Description obj The GameObject or MonoScript to query Returns Texture2D Returns the custom icon associated with the object. If there is no custom icon associated with the object, returns null. Description Gets the custom icon associated ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0a212619fc54_doc_3
github
scripting
What does `IPoolable` do in this Unity script? Explain its purpose and signature.
Retrieves an object from the non-MonoBehaviour-based pool for the specified type.The type of the poolable object.The poolable object from the pool. Signature: ```csharp public static T GetPure<T>() where T : class, IPoolable => _poolService.GetPure<T>(); ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e86ebf2b0978_doc_1
github
scripting
What does `PoolService` do in this Unity script? Explain its purpose and signature.
Initializes a new instance of the PoolService class with the provided configuration.The pool configuration. Signature: ```csharp public PoolService(PoolConfig config) => _config = config; ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_fe7f3f03c1b9
unity_docs
xr
What are the parameters of `Media.MediaEncoder.AddFrame` in Unity?
Returns bool True if the operation succeeded. False otherwise. Description Appends a frame to the file's video track. Keep the number of video frames and audio samples aligned so that each track is syncrhonized as much as possible. For instance, in a file with 30FPS video and 48KHz audio, each added video frame should ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_66ebbb1ccc3e
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUILayout.TagField`.
assed in here will override settings defined by the style . Additional resources: GUILayout.Width , GUILayout.Height , GUILayout.MinWidth , GUILayout.MaxWidth , GUILayout.MinHeight , GUILayout.MaxHeight , GUILayout.ExpandWidth , GUILayout.ExpandHeight . Returns string The tag selected by the user. Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8cc7bef3d85e
unity_docs
scripting
What is `Effector2D` in Unity? Explain its purpose and usage.
Effector2D class in UnityEngine / Inherits from: Behaviour / Implemented in: UnityEngine.Physics2DModule Description A base class for all 2D effectors. Properties Property Description colliderMask The mask used to select specific layers allowed to interact with the effector. useColliderMask Should the col...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a5e2d1118569
unity_docs
physics
In Unity's 'Types of 2D primitive GameObjects', what is 'Create a 2D primitive GameObject' and how does it work?
To create one of these preset 2D primitive GameObjects, go to GameObject > 2D Object > Sprites or Create > 2D > Sprites and select one of the available options: Triangle Square Circle Capsule Isometric Diamond Hexagon Flat-Top Hexagon Point-Top 9-Sliced
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6bdee559f018
unity_docs
scripting
What is `Sprite` in Unity? Explain its purpose and usage.
Sprite class in UnityEngine / Inherits from: Object / Implemented in: UnityEngine.CoreModule Description Represents a Sprite object for use in 2D gameplay. Sprites are 2D graphic objects used for characters, props, projectiles and other elements of 2D gameplay. The graphics are obtained from bitmap images -...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1e8bffdb6fa3
unity_docs
rendering
What is `Rendering.CommandBuffer.SetGlobalRayTracingAccelerationStructure` in Unity? Explain its purpose and usage.
CommandBuffer.SetGlobalRayTracingAccelerationStructure Declaration public void SetGlobalRayTracingAccelerationStructure (string name , Rendering.RayTracingAccelerationStructure accelerationStructure ); Declaration public void SetGlobalRayTracingAccelerationStructure (int nameID , Rendering.RayTracingAccele...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d5c7b45a5edd
unity_docs
editor
Show me a Unity code example for 'Get started with UI Toolkit'.
abel, button, and toggle into your window. In the Editor folder, select Assets > Create > UI Toolkit > UI Document to create a UXML file called SimpleCustomEditor_UXML.uxml . Select the arrow on SimpleCustomEditor_UXML.uxml in the Project window. Double-click inlineStyle to open SimpleCustomEditor_UXML.uxml in a text e...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2564f2164848
unity_docs
scripting
What is `Animations.ParentConstraint` in Unity? Explain its purpose and usage.
ParentConstraint class in UnityEngine.Animations / Inherits from: Behaviour / Implemented in: UnityEngine.AnimationModule Implements interfaces: IConstraint Description Constrains the orientation and translation of an object to one or more source objects. The constrained object behaves as if it is in the hier...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c6689e422a61
unity_docs
scripting
Explain 'Rendering lines' in Unity.
The Line Renderer component takes an array of two or more points in 3D space, and draws a straight line between each one. You can use a Line Renderer to draw anything from a simple straight line to a complex spiral. The line is always continuous; if you need to draw two or more completely separate lines, you should use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7666f45d76b7
unity_docs
editor
What is `SceneManagement.SceneSetup` in Unity? Explain its purpose and usage.
SceneSetup class in UnityEditor.SceneManagement Description The setup information for a Scene in the SceneManager. This cannot be used in Play Mode. Properties Property Description isActive If the Scene is active. isLoaded If the Scene is loaded. path Path of the Scene. Should be relative to the project fol...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b0f29e16d05e
unity_docs
scripting
What is `Screen.fullScreen` in Unity? Explain its purpose and usage.
Screen.fullScreen public static bool fullScreen ; Description Enables full-screen mode for the application. Use this property to toggle full-screen mode: ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { // Toggle fullscreen Screen.fullScreen = !Screen.fullScreen; } } ``` ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_904f66f982d6
unity_docs
rendering
Explain 'Add material properties' in Unity.
To assign material properties to a Shader object in ShaderLab , you place a Properties block inside a Shader block. If you want to access some of those properties in a shader program , you need to declare a Cg/HLSL variable with the same name and a matching type. For example these shader properties: ``` _MyColor ("Some...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b8dd2f8d5157
unity_docs
scripting
Explain 'Scene view context menu' in Unity.
Use the Scene view context menu to access common Scene view actions directly in the scene rather than from the menu toolbar . The menu options that display in the Scene view context menu depend on your current selection and the tool context enabled in the Tools overlay. If you’ve selected a GameObject , the Scene view ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d77183c1b5e
unity_docs
animation
Give me an overview of the `AnimatorControllerParameter` class in Unity.
AnimatorControllerParameter class in UnityEngine / Implemented in: UnityEngine.AnimationModule Description Used to communicate between scripting and the controller. Some parameters can be set in scripting and used by the controller, while other parameters are based on Custom Curves in Animation Clips and can be ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d94ebf8a43cb
github
scripting
Write a Unity Editor script for Addressable Material Editor
```csharp using System; using System.Linq; using UnityEditor; using UnityEditor.UIElements; using UnityEditorInternal; using UnityEngine; using UnityEngine.UIElements; using static UnityEditor.EditorGUI; using UnityObject = UnityEngine.Object; namespace PassivePicasso.SimplyAddress { [CustomEditor(typeof(Addressa...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_7e6bbc721fb5
unity_docs
xr
In Unity's 'XR', what is 'Additional resources and examples' and how does it work?
⚙️ Sample project : XR Interaction Toolkit samples ⚙️ Sample project : AR Foundation Samples 💡 Resources : Build for XR and spatial computing 💡 Resources : Unity Learn XR resources 👥 Community : Join the conversation on Unity Discussions for XR 💡 Resources : Unity Blog XR posts 💡 Resources : XR Glossary 📖 E-Book ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d1e42c0bf943
github
scripting
Write a Unity C# script called String Variable Text
```csharp using System; using GI.UnityToolkit.Variables; using UnityEngine; namespace GI.UnityToolkit.Components.UI.Variables { public class StringVariableText : TextComponent { [SerializeField] private StringVariable stringVariable; [SerializeField, Tooltip("Displays with as-is if left empty,...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_2115224c98aa
unity_docs
math
What is `Unity.Hierarchy.Hierarchy.Add` in Unity? Explain its purpose and usage.
Hierarchy.Add Declaration public Unity.Hierarchy.HierarchyNode Add (ref Unity.Hierarchy.HierarchyNode parent ); Parameters Parameter Description parent The parent of the hierarchy node to add. Returns HierarchyNode A hierarchy node. Description Adds a new node that has a specified parent node to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5714475e3638
unity_docs
scripting
Explain 'TextElement' in Unity.
The TextElement displays text in a UI. If you create a custom control for displaying text, you can inherit it from a TextElement . ## Create a TextElement You can create a TextElement with UXML or C#. The following C# example creates a TextElement with a text value and some styles: ``` var textElement = new TextEleme...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_153d3e1f3cd6
unity_docs
scripting
What is `ParticleSystem.InheritVelocityModule.curveMultiplier` in Unity? Explain its purpose and usage.
ParticleSystem.InheritVelocityModule.curveMultiplier public float curveMultiplier ; Description Change the curve multiplier. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall curve multiplier. ```csharp using UnityEngine; using System.Collections;...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c46c037d207b
unity_docs
rendering
What is `Material.SetInteger` in Unity? Explain its purpose and usage.
Material.SetInteger Declaration public void SetInteger (string name , int value ); Declaration public void SetInteger (int nameID , int value ); Parameters Parameter Description nameID Property name ID, use Shader.PropertyToID to get it. value Integer value to set. name Property name, e.g. "_Sr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b43aafb1615d
unity_docs
rendering
What is `Profiling.FrameDataView.GetGfxResourceInfo` in Unity? Explain its purpose and usage.
FrameDataView.GetGfxResourceInfo Declaration public bool GetGfxResourceInfo (ulong gfxResourceId , out Profiling.FrameDataView.GfxResourceInfo info ); Parameters Parameter Description gfxResourceId Graphics resource identifier. info Graphics resource information output struct with instance ID and other ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_78b97bdfd5a1
unity_docs
math
Explain 'Rotation and orientation' in Unity.
Use euler angles or quaternions in Unity’s left hand coordinate system to control the rotation and orientation of GameObjects . Topic Description Quaternion and euler rotations in Unity In Unity, you can use both Euler angles and quaternions to represent rotations and orientation. Programming with the Quaternion class ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80fcd12a842b
unity_docs
xr
What is `Networking.UnityWebRequest.isModifiable` in Unity? Explain its purpose and usage.
UnityWebRequest.isModifiable public bool isModifiable ; Description Returns true while a UnityWebRequest ’s configuration properties can be altered. (Read Only) Examples of configuration properties include downloadHandler , method and url . This property will return false after a call to Send .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_27e8c9e5dfff
github
scripting
Write a Unity C# MonoBehaviour script called Mono Poolable
```csharp using UnityEngine; namespace Pool.Runtime { /// <summary> /// Abstract class to be inherited by MonoBehaviour-based poolable objects. /// Implements the IPoolable interface, providing the core lifecycle methods for poolable objects. /// </summary> public abstract class MonoPoolable : Mon...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
gh_f522b91ce703_doc_21
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Represents an object which can receive ten arguments as part of its initialization process.Base interface of . Signature: ```csharp public interface ITenArguments ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_c6897f416421
unity_docs
rendering
What is `Tilemaps.TilemapRenderer.Mode.Chunk` in Unity? Explain its purpose and usage.
TilemapRenderer.Mode.Chunk Description Batches each Sprite from the Tilemap into grouped chunks to be rendered. Use this mode if Sprites on the Tilemap do not need to interact with any non-Tilemap Renderers and to optimize performance..
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_88bdd113e54a
unity_docs
math
What is `AndroidJNI.GetBooleanArrayElement` in Unity? Explain its purpose and usage.
AndroidJNI.GetBooleanArrayElement Declaration public static bool GetBooleanArrayElement (IntPtr array , int index ); Description Returns the value of one element of a primitive array. This function is a special case of GetBooleanArrayRegion(), called with region size set to 1. Additional resources: Java Nati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_01eb515ed713
unity_docs
math
What are the parameters of `Search.IQueryEngineFilter.AddOperator` in Unity?
Returns QueryFilterOperator The added, or existing, QueryFilterOperator . Description Add a custom filter operator specific to the filter. Custom operators defined on a filter take precedence over operators defined globally on the QueryEngine . This is useful if you wish to have a custom operator only for a specific fi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f126d11cbe7e
unity_docs
scripting
What is `Rendering.SubMeshDescriptor.indexStart` in Unity? Explain its purpose and usage.
SubMeshDescriptor.indexStart public int indexStart ; Description Starting point inside the whole Mesh index buffer where the face index data is found. This property, together with indexCount , determines which part of the whole index buffer is used by a particular sub-mesh. Values in the index buffer are inter...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e1b09689b82a
unity_docs
scripting
Explain 'Activate and access Particle System modules' in Unity.
The Particle System component has many properties, and for convenience, the Inspector organises them into collapsible sections called “modules”. These modules are documented in separate pages. See documentation on Particle System Modules to learn about each one. To expand and collapse modules, click the bar that shows ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.