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_916899d694b6
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R16G16_UInt` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R16G16_UInt Description A two-component, 32-bit unsigned integer format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4121b1d781e0
unity_docs
scripting
In Unity's 'RectIntField', what is 'Example' and how does it work?
The following UXML example creates a RectIntField: ``` <UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements"> <RectIntField label="UXML Field" name="the-uxml-field" /> </UXML> ``` The following C# example illustrates some of the customizable functionalities of the RectIntField: ``` /// <sample> // Ge...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6bd19b306b63
unity_docs
rendering
Show me a Unity C# example demonstrating `SpeedTreeImporter.SearchAndRemapMaterials`.
use them instead of the internal materials. Unity follows specific naming conventions when importing SpeedTree materials. This allows Unity to search for matching material assets by name. The materialFolderPath is relative to the project folder, for example "Assets/MyModel Materials". Throws ArgumentNullException ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d1042842175b
unity_docs
scripting
What is `UIElements.UxmlHash128AttributeDescription.GetValueFromBag` in Unity? Explain its purpose and usage.
UxmlHash128AttributeDescription.GetValueFromBag Declaration public Hash128 GetValueFromBag ( UIElements.IUxmlAttributes bag , UIElements.CreationContext cc ); Parameters Parameter Description bag The bag of attributes. cc The context in which the values are retrieved. Returns Hash128 The value of...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_df26a28ee8fa
github
scripting
Write a Unity C# XR/VR script for Base Cursor
```csharp // Copyright (c) 2022 Takahiro Miyaura // Released under the MIT license // http://opensource.org/licenses/mit-license.php using System.Collections.Generic; using UnityEngine; namespace ReSeul.OpenXRSample { public class BaseCursor : MonoBehaviour { private static readonly List<BaseCursor> C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_669c45b1fde3
unity_docs
rendering
What is `MaterialEditor.BeginAnimatedCheck` in Unity? Explain its purpose and usage.
MaterialEditor.BeginAnimatedCheck Declaration public void BeginAnimatedCheck ( Rect totalPosition , MaterialProperty prop ); Declaration public void BeginAnimatedCheck ( MaterialProperty prop ); Parameters Parameter Description totalPosition Rectangle on the screen to use for the control, including...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57285e675b6a
unity_docs
rendering
What is `Rendering.BatchBufferTarget` in Unity? Explain its purpose and usage.
BatchBufferTarget enumeration Description Expected target for the buffer passed to BatchRendererGroup.AddBatch . . Properties Property Description Unknown This is the default uninitialized value for this enum. It is here as a placeholder. Unity will never return this, and you will never use it. UnsupportedBy...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1b55c3a6a27
unity_docs
editor
What is `Search.ISearchNode` in Unity? Explain its purpose and usage.
ISearchNode interface in UnityEditor.Search Implements interfaces: IQueryNode Description Interface representing a query node. Properties Property Description exact True if the word or text should match exactly, false if it is a "contains" operation. searchValue Word or text used for the search.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2d025953d15e
unity_docs
scripting
What is `Unity.Android.Gradle.AndroidComponents` in Unity? Explain its purpose and usage.
AndroidComponents class in Unity.Android.Gradle / Inherits from: Unity.Android.Gradle.BaseBlock Description The C# definition of the androidComponents element in a gradle file. For more information about the element, see Android's documentation: androidComponents element Properties Property Description O...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cfd107de2a49
unity_docs
xr
What is `Networking.UnityWebRequest.isNetworkError` in Unity? Explain its purpose and usage.
Method group is Obsolete Description Returns true after this UnityWebRequest encounters a system error. (Read Only) Examples of system errors include failure to resolve a DNS entry, a socket error or a redirect limit being exceeded. When this property returns true , the error property will contain a human-re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_50bb4d1f42b8
unity_docs
scripting
What is `TerrainTools.PaintDetailsToolUtility.LoadDetailIcons` in Unity? Explain its purpose and usage.
PaintDetailsToolUtility.LoadDetailIcons Declaration public static GUIContent[] LoadDetailIcons (DetailPrototype[] prototypes ); Parameters Parameter Description prototypes The terrain data object. Returns GUIContent[] Returns the detail icons. Description Gets the icons of the detail prototypes.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57112ac2c808
unity_docs
scripting
What is `Rendering.AttachmentDescriptor.storeAction` in Unity? Explain its purpose and usage.
AttachmentDescriptor.storeAction public Rendering.RenderBufferStoreAction storeAction ; Description The store action to use with this attachment when the RenderPass ends. Only used when either ConfigureTarget or ConfigureResolveTarget has been called.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7ad2fe5b1584
github
scripting
Write a Unity C# MonoBehaviour script called FB Callback Helper
```csharp #if UNITY_EDITOR || UNITY_ANDROID using UnityEngine; namespace SimpleFileBrowser { public class FBCallbackHelper : MonoBehaviour { private System.Action mainThreadAction = null; private void Awake() { DontDestroyOnLoad( gameObject ); } private void Update() { if( mainThreadAction != nu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_902da35a4d09
unity_docs
rendering
In Unity's 'Manage references', what is 'Assigning references' and how does it work?
To assign a reference to a property, in the property field in the Inspector window, do one of the following: From the Hierarchy or Project windows, drag a compatible item into the field. To open a search window for the property field, select Object Picker (⊙). The search window filters for references that match the pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_24c520709f1b
unity_docs
editor
Show me a Unity code example for 'Contextual menu events'.
contextual menus, attach the ContextualMenuManipulator to a visual element . This manipulator displays a contextual menu after either a right button mouse up event or a menu key up event. The ContextualMenuManipulator manipulator also adds a callback that responds to a ContextualMenuPopulateEvent . The following code e...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_230daf45f88c
unity_docs
xr
What is `iOS.Device.RequestStoreReview` in Unity? Explain its purpose and usage.
Device.RequestStoreReview Declaration public static bool RequestStoreReview (); Returns bool Value indicating whether the underlying API is available or not. False indicates that the iOS version isn't recent enough or that the StoreKit framework is not linked with the app. Description Request App Store rat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2eed3c5bfa91
unity_docs
rendering
In Unity's 'Asset Pipeline preferences reference', what is 'Unity Accelerator (Cache Server)' and how does it work?
Property Function Default Mode Define the default setting for the Cache Server, whether to enable or disable it by default. You can override this per Project in the Unity Editor settings. For more information, see Unity Accelerator . Default IP address Set the default IP address for the Cache Server to use. You can ove...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_22cc08b42f4d
unity_docs
rendering
What is `ImageConversion.EncodeArrayToTGA` in Unity? Explain its purpose and usage.
ImageConversion.EncodeArrayToTGA Declaration public static byte[] EncodeArrayToTGA (Array array , Experimental.Rendering.GraphicsFormat format , uint width , uint height , uint rowBytes ); Parameters Parameter Description array The byte array to convert. format The pixel format of the image data. wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_95a26c20b157
unity_docs
scripting
What is `Rendering.ScopedSubPass.Dispose` in Unity? Explain its purpose and usage.
ScopedSubPass.Dispose Declaration public void Dispose (); Description Ends the current sub pass in the ScriptableRenderContext that was used to create the ScopedSubPass . Additional resources: ScriptableRenderContext.BeginScopedSubPass .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_13fb174da828
unity_docs
animation
What is `Animations.RotationConstraint.RemoveSource` in Unity? Explain its purpose and usage.
RotationConstraint.RemoveSource Declaration public void RemoveSource (int index ); Parameters Parameter Description index The index of the source to remove. Description Removes a source from the component. Throws InvalidOperationException, if the list of sources is empty. Throws ArgumentOutOfRangeExceptio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8407dbc25916
unity_docs
scripting
Give me an overview of the `Component` class in Unity.
Component class in UnityEngine / Inherits from: Object / Implemented in: UnityEngine.CoreModule Description Base class for everything attached to a GameObject . Note that your code will never directly create a Component. Instead, you write script code, and attach the script to a GameObject . Additional reso...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc150ebe7b2d
unity_docs
scripting
What are the parameters of `Handles.Slider2D` in Unity?
Returns Vector3 The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the position value passed into the function. Description Make a 3D slider that moves along a plane defined by two axes. This method will draw a 3D-draggable handle on the screen. The ha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_305d99c3801b
unity_docs
scripting
In Unity's 'Yield instruction reference', what is 'Runtime yield instructions' and how does it work?
Unity has a set of custom yield instructions derived from UnityEngine.YieldInstruction that you can use to resume after a specified time, when a specified conditions is met, or at specific points in the Player loop. Instruction Description AsyncOperation Suspends a coroutine and resumes when an asynchronous operation c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_710fa1a988de
unity_docs
rendering
Show me a Unity C# example demonstrating `ComputeShader.keywordSpace`.
scripts . keywordSpace represents all keywords declared in the source file for a compute shader. For information about declaring and using shader keywords in shader source files, see Shader keywords . This example iterates over the local shader keywords in the local keyword space for a compute shader. It determines w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_968e5f668383
unity_docs
editor
What is `EditorUserBuildSettings.overrideTextureCompression` in Unity? Explain its purpose and usage.
EditorUserBuildSettings.overrideTextureCompression public static Build.OverrideTextureCompression overrideTextureCompression ; Description The asset importing override of texture compression. This setting lets you override the texture compression settings that Unity uses when it imports assets. This is mostly...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_397fcee8c004
unity_docs
scripting
In Unity's 'Create a runtime binding in C# scripts', what is 'Report a change' and how does it work?
You can create the bindable properties in the same way as other data sources, which means that you can also use VisualElement types as data sources . The main difference between a VisualElement type and other data sources is that VisualElement types come with built-in versioning. You must use the built-in versioning of...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a84f8cdef8c
unity_docs
xr
What are the parameters of `RenderTexture.ctor` in Unity?
Description Creates a new RenderTexture object. The render texture is created with width by height size, with a depth buffer of depth bits (depth can be 0, 16, 24 or 32), and in format format and with sRGB read / write on or off. Note that constructing a RenderTexture object does not create the hardware representation ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_342afdf8e5ed
github
scripting
Write a Unity C# MonoBehaviour script called Prefab Meta Data
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; namespace PlainSaveLoad { public class PrefabMetaData : MonoBehaviour { public string prefabName; public string folder; public void Start() { gameObject.name = prefabName; ...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_a4dd949b1c4a
unity_docs
scripting
Show me a Unity C# example demonstrating `GUI.EndGroup`.
GUI.EndGroup Declaration public static void EndGroup (); Description End a group. Should be attached with GUI.BeginGroup . Additional resources: BeginGroup . ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void OnGUI() { // Constrain all drawing to be with...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4e4a5d8eecd8
unity_docs
rendering
What is `BoneWeight` in Unity? Explain its purpose and usage.
BoneWeight struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Describes 4 skinning bone weights that affect a vertex in a mesh. Elements in this struct must be in descending order of weight value. The sum of all weight values must be 1. If a vertex is affected by fewer than 4 bones, each...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_11b4c3e00ba6
unity_docs
rendering
What is `Rendering.RayTracingAccelerationStructure.BuildSettings` in Unity? Explain its purpose and usage.
BuildSettings struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Contains options for building a RayTracingAccelerationStructure . This struct packages together parameters for the CommandBuffer.BuildRayTracingAccelerationStructure and RayTracingAccelerationStructure.Build ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8388a481fc06
unity_docs
scripting
Show me a Unity C# example demonstrating `MonoBehaviour.OnDisable`.
s: When a component of an active GameObject is disabled via code or the Inspector. When an enabled component's parent GameObject is deactivated. When the component or parent GameObject is destroyed by calling Object.Destroy . When the scene is unloaded. When scripts are reloaded as part of a domain reload. OnDis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb9d49b5a465
unity_docs
input
Show me a Unity C# example demonstrating `TouchScreenKeyboard.Open`.
f user can input more than one line of text. The secure identifies whether the keyboard is used for password. Text in the input field will be hidden from the user except the recently typed character. The keyboard can be opened in the alert mode too. The placeholder string will be displayed when there is no other ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d3969b08f1c8
unity_docs
physics
What are the parameters of `Compilation.CompilationPipeline.compilationStarted` in Unity?
Description An event that is invoked on the main thread when the compilation of assemblies starts. CompilationPipeline.compilationStarted is called before the first CompilationPipeline.assemblyCompilationStarted event. You can use the context to match CompilationPipeline.compilationStarted and CompilationPipeline.compi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a4664d8f089c
unity_docs
scripting
What is `PrefabUtility.IsPartOfRegularPrefab` in Unity? Explain its purpose and usage.
PrefabUtility.IsPartOfRegularPrefab Declaration public static bool IsPartOfRegularPrefab ( Object componentOrGameObject ); Parameters Parameter Description componentOrGameObject The object to check. Must be a component or GameObject. Returns bool True if the object is part of a regular Prefab. Descri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8983ae22800c
unity_docs
xr
Show me a Unity code example for 'Unity XR Input'.
ice, such as a controller, mobile phone, or headset. It can contain information about device tracking, buttons, joysticks, and other input controls. For more information on the InputDevice API, see documentation on InputDevice . Use the XR.InputDevices class to access input devices that are currently connected to the X...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3715b0e5f2ed
unity_docs
rendering
Explain 'Transparent Cutout Shader Family' in Unity.
Note. Unity 5 introduced the Standard Shader which replaces these shaders . The Transparent Cutout shaders are used for objects that have fully opaque and fully transparent parts (no partial transparency). Things like chain fences, trees, grass, etc. ## Transparent Cutout Vertex-Lit Assets needed: One Base texture wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc1bac0b3b0d
unity_docs
scripting
What is `AssetBundleRequest` in Unity? Explain its purpose and usage.
AssetBundleRequest class in UnityEngine / Inherits from: ResourceRequest / Implemented in: UnityEngine.AssetBundleModule Description Asynchronous load request from an AssetBundle . Additional resources: AsyncOperation . Properties Property Description allAssets Asset objects with sub assets being loaded...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a07c717fdb93
unity_docs
scripting
What is `Debug.LogError` in Unity? Explain its purpose and usage.
Debug.LogError Declaration public static void LogError (object message ); Declaration public static void LogError (object message , Object context ); Parameters Parameter Description message String or object to be converted to string representation for display. context Object to which the message ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1cff19b3e63e
unity_docs
rendering
Explain 'Transparent Shader Family' in Unity.
Note. Unity 5 introduced the Standard Shader which replaces these shaders . The Transparent shaders are used for fully- or semi-transparent objects. Using the alpha channel of the Base texture, you can determine areas of the object which can be more or less transparent than others. This can create a great effect for gl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d004048514a5
unity_docs
networking
Explain 'Unity Building Blocks' in Unity.
Learn how to use Unity Building Blocks to add functional gameplay features to your project. Topic Description Introduction to Unity Building Blocks Learn about Unity Building Blocks and how to add them to your project. LiveOps Building Blocks Use the Unity Building Blocks for the Achievements, Player Accounts, and Lead...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3c923e38084d
unity_docs
animation
What is `AnimatorStateInfo` in Unity? Explain its purpose and usage.
AnimatorStateInfo struct in UnityEngine / Implemented in: UnityEngine.AnimationModule Description Information about the current or next state. Properties Property Description fullPathHash The full path hash for this state. length Current duration of the state. loop Is the state looping. normalizedTime Nor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f771a5789060
unity_docs
scripting
What is `GUILayout.TextArea` in Unity? Explain its purpose and usage.
GUILayout.TextArea Declaration public static string TextArea (string text , params GUILayoutOption[] options ); Declaration public static string TextArea (string text , int maxLength , params GUILayoutOption[] options ); Declaration public static string TextArea (string text , GUIStyle style , param...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_85e2c3cf8d07
unity_docs
editor
Explain 'Package layout' in Unity.
This is the package layout recommended for custom packages: ``` <package-root> ├── package.json ├── README.md ├── CHANGELOG.md ├── LICENSE.md ├── Third Party Notices.md ├── Editor │ ├── <company-name>.<package-name>.Editor.asmdef │ └── EditorExample.cs ├── Runtime │ ├── <company-name>.<package-name>.asmdef │...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f5dae5c8018d
unity_docs
math
Show me a Unity C# example demonstrating `Mathf.Sin`.
an acceptable range for input angle values for this method, beyond which the calculation will fail. On windows, the acceptable range is approximately between -9223372036854775295 to 9223372036854775295. This range may differ on other platforms. For values outside of the acceptable range, the Sin method returns the inpu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ea0a66023ded
unity_docs
ui
In Unity's 'UIE-transition-event-example', what is 'Example overview' and how does it work?
The example creates a custom Editor window with a button and color palette. If you click the button, the following appears: A transition starts to change the color palette from blue to green. The transition events that are sent during the transition. The duration of the events. You can find the completed files that thi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_94a804b44228
unity_docs
audio
What is `AudioSource.timeSamples` in Unity? Explain its purpose and usage.
AudioSource.timeSamples public int timeSamples ; Description The current playback position of the AudioSource in PCM samples. Use this to read current playback time or to seek to a new playback time in samples, if you want more precise timing than what time variable allows. ```csharp using UnityEngine; usin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49ea2dfd743e
unity_docs
physics
What is `JointMotor2D.maxMotorTorque` in Unity? Explain its purpose and usage.
JointMotor2D.maxMotorTorque public float maxMotorTorque ; Description The maximum force that can be applied to the Rigidbody2D at the joint to attain the target speed. Additional resources: Rigidbody2D class, motorSpeed .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9dbe566c14cc
unity_docs
scripting
In Unity's 'Event function execution order', what is 'Run code on runtime intialization' and how does it work?
You can run code on initialization of the runtime application by applying the [RuntimeInitializeOnLoadMethodAttribute] to methods. You can also specify a RunTimeInitializeLoadType attribute parameter to control where in the Player loop the attributed code executes. For more information on the execution order of methods...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a3971c6e6f2e
github
scripting
Write a Unity C# physics script for Glass Audio
```csharp using System.Collections; using UnityEngine; public class GlassAudio : MonoBehaviour { public AudioSource GlassAudioSource; public AudioClip[] PickUpClips; public AudioClip[] DropClips; public AudioClip[] PourClips; [Header("Collision Settings")] [SerializeField] private float minImp...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_5dfc878ac4a2
unity_docs
scripting
Explain 'Manage GameObjects in the Scene view' in Unity.
Understand how to manage GameObjects in the Scene view in the Unity Editor. Position GameObjects, snap them to the grid, and create overlays to manage authoring workflows. Topic Description Position GameObjects Use transform tools to move, rotate, scale, and position GameObjects in your scene. Pick and select GameObjec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_30a51a978a24
unity_docs
rendering
What are the parameters of `GUILayout.Button` in Unity?
Returns bool true when the users clicks the button. Description Make a single press button. Create a Button that can be pressed and released as a normal button. When this Button is released the Button returns the expected true value. If the mouse is moved off the button it is not clicke...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e308cce787c7
unity_docs
scripting
Show me a Unity C# example demonstrating `LensFlare.fadeSpeed`.
LensFlare.fadeSpeed public float fadeSpeed ; Description The fade speed of the flare. Additional resources: Lens flare component , flare assets . ```csharp using UnityEngine;public class Example : MonoBehaviour { // Increments the strenght of the Lensflare lf when the Transform tr // gets closer to the Le...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_653f4e8b0344
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystemAnimationMode.Sprites`.
ParticleSystemAnimationMode.Sprites Description Use a list of sprites to construct a sequence of animation frames. Defines the sprites that are added to Texture Sheet Animation. Additional resources: ParticleSystemAnimationMode.Grid ```csharp using UnityEngine;// A particle sprite example. // The gameobject this ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_71711c5d2cb5
unity_docs
ui
What is `FullScreenMovieControlMode` in Unity? Explain its purpose and usage.
FullScreenMovieControlMode enumeration Description Describes options for displaying movie playback controls. Windows Store Apps : OS doesn't provide a Stop button control because of this Unity will stop a video if Escape or Back Button is pressed if video is launched with FullScreenMovieControlMode.Full or...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c30617656e54
unity_docs
rendering
What is `Rendering.LoadStoreActionDebugModeSettings.LoadStoreDebugModeEnabled` in Unity? Explain its purpose and usage.
LoadStoreActionDebugModeSettings.LoadStoreDebugModeEnabled public static bool LoadStoreDebugModeEnabled ; Description Enables or disables Unity highlighting undefined areas of the display. If you set LoadStoreDebugModeEnabled to true , Unity highlights undefined areas of the display that might cause renderin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_05bae5c334cb
unity_docs
audio
What is `AudioClip.Create` in Unity? Explain its purpose and usage.
AudioClip.Create Declaration public static AudioClip Create (string name , int lengthSamples , int channels , int frequency , bool stream ); Declaration public static AudioClip Create (string name , int lengthSamples , int channels , int frequency , bool stream , AudioClip.PCMReaderCallback pcm...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ed9188dad4db
unity_docs
scripting
What is `Unity.Android.Gradle.Manifest.Action.ctor` in Unity? Explain its purpose and usage.
Action Constructor Declaration public Action (); Declaration public Action ( Unity.Android.Gradle.Manifest.Action action ); Parameters Parameter Description action Element to copy. Description Element constructor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_241855e9cb8e
unity_docs
scripting
What is `Search.SearchExpression.IsTrue` in Unity? Explain its purpose and usage.
SearchExpression.IsTrue Declaration public static bool IsTrue ( Search.SearchItem item ); Parameters Parameter Description item SearchItem to test. Returns bool Returns true if the value of the SearchItem is truish. Description Check if the internal value of a SearchItem is truish. It means the va...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2aad9351781
unity_docs
math
What is `UIElements.UxmlAttributeConverter_1` in Unity? Explain its purpose and usage.
UxmlAttributeConverter<T0> class in UnityEditor.UIElements Description Converts a UxmlAttribute type to and from a string. Fields marked with UxmlAttributeAttribute are represented in UXML by a single string attribute, however, to properly serialize these attributes, you must declare a UxmlAttributeConvert...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7375de3ea7fc_doc_7
github
scripting
What does `RemovePackage` do in this Unity script? Explain its purpose and signature.
Removes a given package from the project Signature: ```csharp public static void RemovePackage(string name, Action<bool> success) ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_28c4df4664f9
unity_docs
editor
What are the parameters of `EditorWindow.HasOpenInstances` in Unity?
Returns bool Returns true if an EditorWindow , matching the specified type, is open. Returns false otherwise. Description Checks if an editor window is open. ```csharp using UnityEngine; using UnityEditor; using UnityEngine.UIElements; public class HasOpenInstancesExample : EditorWindow { [MenuItem("Examples/Has O...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f013a79f665d
unity_docs
scripting
What is `AI.NavMesh.CalculatePath` in Unity? Explain its purpose and usage.
NavMesh.CalculatePath Declaration public static bool CalculatePath ( Vector3 sourcePosition , Vector3 targetPosition , int areaMask , AI.NavMeshPath path ); Parameters Parameter Description sourcePosition The initial position of the path requested. targetPosition The final position of the path requ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28db44f74dcd
unity_docs
physics
What is `ContactFilter2D.minNormalAngle` in Unity? Explain its purpose and usage.
ContactFilter2D.minNormalAngle public float minNormalAngle ; Description Sets the contact filter to filter the results to only include contacts with collision normal angles that are greater than this angle. This is only used if useNormalAngle is true. If the minNormalAngle is set to - Mathf.Infinity or Ma...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d5f9d370f872_doc_15
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Stores the locomotion provider for snap turning. Signature: ```csharp public SnapTurnProviderBase snapTurnProvider ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_2df6c3668a1f
unity_docs
editor
Show me a Unity C# example demonstrating `PlayerSettings.Android.preferredInstallLocation`.
PlayerSettings.Android.preferredInstallLocation public static AndroidPreferredInstallLocation preferredInstallLocation ; Description Preferred application install location. ```csharp using UnityEngine; using UnityEditor; using UnityEditor.Build;public class PreferredInstallLocationSample : MonoBehaviour { [...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e7b7145e2f45
unity_docs
editor
Explain 'Introduction to assemblies in Unity' in Unity.
Unity provides two special asset types, Assembly Definitions and Assembly References, to help organize your scripts into assemblies. An assembly is a C# code library that contains the compiled classes and structs that are defined by your scripts and which also define references to other assemblies. For more information...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2d25f409da6c
unity_docs
ui
In Unity's 'Descendant selectors', what is 'Syntax' and how does it work?
A descendant selector consists of multiple simple selectors separated by a space: ``` selector1 selector2 {...} ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_11a545c611b5
unity_docs
rendering
What is `Unity.Profiling.LowLevel.Unsafe.ProfilerUnsafeUtility.FlowEvent` in Unity? Explain its purpose and usage.
ProfilerUnsafeUtility.FlowEvent Declaration public static void FlowEvent (uint flowId , Unity.Profiling.ProfilerFlowEventType flowEventType ); Parameters Parameter Description flowId Profiler flow identifier. flowEventType Flow event type. Description Add flow event to a Profiler sample. Use Profiler...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f443dcf58e41
unity_docs
editor
What is `EditorGUILayout.Vector2IntField` in Unity? Explain its purpose and usage.
EditorGUILayout.Vector2IntField Declaration public static Vector2Int Vector2IntField (string label , Vector2Int value , params GUILayoutOption[] options ); Declaration public static Vector2Int Vector2IntField ( GUIContent label , Vector2Int value , params GUILayoutOption[] options ); Parameters...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1926eb9870d
unity_docs
rendering
What is `ParticleSystemAnimationRowMode` in Unity? Explain its purpose and usage.
ParticleSystemAnimationRowMode enumeration Description The mode used for selecting rows of an animation in the Texture Sheet Animation Module. Properties Property Description Custom Use a specific row for all particles. Random Use a random row for each particle. MeshIndex Use the mesh index as the row, so tha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0beb52eeed2e
unity_docs
scripting
What is `Experimental.GraphView.Node.ctor` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Node.Node Constructor Declaration public Node (); Parameters Parameter Description nodeOrientation The orientation. Description Node's constructor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e3d8a09b6391
unity_docs
scripting
What is `Application.SetStackTraceLogType` in Unity? Explain its purpose and usage.
Application.SetStackTraceLogType Declaration public static void SetStackTraceLogType ( LogType logType , StackTraceLogType stackTraceType ); Description Set stack trace logging options. The default value is StackTraceLogType.ScriptOnly . Useful when you want more debugging information when a log message i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_97a384026c05
unity_docs
editor
What are the parameters of `iOS.Xcode.PBXProject.GetAllBuildPhasesForTarget` in Unity?
Returns string[] Returns all of the build phases for the specified target. Description Returns all build phases for the specified target. You can query the type and name of each phase using GetBuildPhaseType and GetBuildPhaseName respectively. ```csharp using UnityEngine; using UnityEditor; using System.IO; using Unity...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_171201c817ea
unity_docs
rendering
In Unity's 'Terrain Settings reference', what is 'Reflection probes' and how does it work?
To control how terrain reflects its environment, set the blend options for adjacent reflection probes and the skybox . Reflection probes create more realistic reflections, but decrease performance. Global environment reflections are controlled from the Lighting window . You can override these reflections for a specific...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49c73fddf9eb
unity_docs
editor
Give me an overview of the `RuntimeInitializeLoadType` class in Unity.
RuntimeInitializeLoadType enumeration Description Specifies when to get a callback during the startup of the runtime or when entering play mode in the Editor. Used with RuntimeInitializeOnLoadMethodAttribute . See the RuntimeInitializeOnLoadMethodAttribute documentation for the execution order between the vario...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_593c24f26c7b
unity_docs
scripting
What is `LightTransport.IDeviceContext.Flush` in Unity? Explain its purpose and usage.
IDeviceContext.Flush Declaration public bool Flush (); Returns bool True if the flush operation was successful. Description Initiates execution of all enqueued operations on the device. Forces the device to begin processing all previously enqueued operations such as buffer reads, writes, and compute opera...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_59aa083dd096
github
scripting
Write a Unity C# animation script for Curve Component
```csharp namespace CurvePickerTool.Samples { using UnityEngine; public class CurveComponent : MonoBehaviour { [SerializeField] private GameObject prefab; [SerializeField] private AnimationCurve curve = new AnimationCurve(new Keyframe(0f, 0f), new Keyframe(1f, 5f)); [SerializeField,...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_fc2f8ca9605e
unity_docs
scripting
What is `UIElements.DropdownField` in Unity? Explain its purpose and usage.
DropdownField class in UnityEngine.UIElements / Inherits from: UIElements.PopupField_1 / Implemented in: UnityEngine.UIElementsModule Description A control that allows the user to pick a choice from a list of options. For more information, refer to UXML element DropdownField . Constructors Constructor D...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f7c30a9e12a7
unity_docs
rendering
What are the parameters of `AssetImporters.ScriptedImporter.OnImportAsset` in Unity?
Description This method must by overriden by the derived class and is called by the Asset pipeline to import files. ```csharp using UnityEngine; using UnityEditor.AssetImporters; using System.IO;[ScriptedImporter(1, "cube")] public class CubeImporter : ScriptedImporter { public float m_Scale = 1; public override...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7fa10c8c86c1
unity_docs
ui
What is `UIElements.ListView.bindItem` in Unity? Explain its purpose and usage.
ListView.bindItem public Action<VisualElement,int> bindItem ; Description Callback for binding a data item to the visual element. The method called by this callback receives the VisualElement to bind, and the index of the element to bind it to. If this property and makeItem are not set, Unity will try to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e34723a22429
unity_docs
scripting
What is `Rendering.ResourcePathAttribute.ctor` in Unity? Explain its purpose and usage.
ResourcePathAttribute Constructor Declaration public ResourcePathAttribute (string path , Rendering.SearchType location ); Parameters Parameter Description location Specify if the given paths are from the builtin, builtinExtra or project resources. path Path targetting the resource Description Creates...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_83726cd1cc50
unity_docs
scripting
What is `ObjectChangeEventStream.Builder.ctor` in Unity? Explain its purpose and usage.
ObjectChangeEventStream.Builder Constructor Declaration public ObjectChangeEventStream.Builder ( Unity.Collections.Allocator allocator ); Parameters Parameter Description allocator The allocator to use. Description Constructs a new instance.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4dca91e7de33
unity_docs
rendering
In Unity's 'Memory Profiler module reference', what is 'Simple view' and how does it work?
The Simple view indicates how much memory the operating system reports as being in use by your application. This value is based on the System Used Memory profiler counter . On platforms that support getting the total memory size of the application from the operating system, the System Memory Usage is over 0 and is the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_24a29ee31027
unity_docs
scripting
Show me a Unity C# example demonstrating `AssetPostprocessor.OnPostprocessPrefab`.
ded asset objects always get the DontSaveInEditor and NotEditable flags added. Added GameObjects and Components always get the DontSaveInEditor flag added. The DontSaveInEditor flag is always set to avoid the object from being saved back into the Prefab source asset, because this duplicates the generated objects every ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9c0590744f2f
unity_docs
editor
In Unity's 'Unity Editor analytics', what is 'Disable Editor Analytics' and how does it work?
If you don’t want to send data to Unity, you can disable Editor analytics. There are two ways to disable Editor analytics. Regardless of which method you choose, the result is the same and your settings are synced: To disable Editor analytics in the Editor: Open the Preferences window . Select General > Disable Editor ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_670fb1c22788_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
WebSocket client for real-time communicationNOTE: This is a stub - requires external WebSocket library (e.g., WebSocketSharp, NativeWebSocket) Signature: ```csharp public class SocketClient : MonoBehaviour ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_2e016b53df09
unity_docs
input
Explain 'Mobile Keyboard' in Unity.
In most cases, Unity will handle keyboard input automatically for GUI elements but it is also easy to show the keyboard on demand from a script. ## GUI Elements The keyboard will appear automatically when a user taps on editable GUI elements. Currently, GUI.TextField , GUI.TextArea and GUI.PasswordField will display ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_88de90726836
unity_docs
scripting
What is `Playables.IPlayable` in Unity? Explain its purpose and usage.
IPlayable interface in UnityEngine.Playables Description Interface implemented by all C# Playable implementations. NOTE: You can use PlayableExtensions methods with all objects that implement IPlayable.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75d5a65f9cb0
unity_docs
scripting
What is `HDROutputSettings.displays` in Unity? Explain its purpose and usage.
HDROutputSettings.displays public static HDROutputSettings[] displays ; Description The list of currently connected displays with possible HDR availability. HDR is currently only supported on the primary display, so this list only contains a single item. Additional resources: HDROutputSettings.main .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1ead2f9152e4
unity_docs
rendering
Show me a Unity C# example demonstrating `ImageConversion.EncodeNativeArrayToPNG`.
ayscale, RGB or RGBA (depending on the passed in format). For single-channel red textures ( R8 , R16 , RFloat and RHalf ), the encoded PNG data will be in grayscale. PNG data will not contain gamma correction or color profile information. The native array that this function returns is allocated with the persis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e7cdd1aa54a6
unity_docs
scripting
Show me a Unity C# example demonstrating `WindZone.mode`.
WindZone.mode public WindZoneMode mode ; Description Defines the type of wind zone to be used (Spherical or Directional). ```csharp // Creates a Directional Wind Zone. using UnityEngine;public class ExampleScript : MonoBehaviour { void Start() { var wind = gameObject.AddComponent<WindZone>(); wind.mode =...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9cdfcd7918f
unity_docs
rendering
What is `Video.VideoPlayer.renderMode` in Unity? Explain its purpose and usage.
VideoPlayer.renderMode public Video.VideoRenderMode renderMode ; Description Where the video content will be drawn. This gets automatically set to the most appropriate value when creating a VideoPlayer . For example, adding a VideoPlayer on a Camera will result in the VideoPlayer initializing its targe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bc11922a1734
unity_docs
ui
In Unity's 'Introduction to UXML', what is 'Namespace' and how does it work?
In UI Toolkit, each element is defined in either the UnityEngine.UIElements or the UnityEditor.UIElements namespace: The UnityEngine.UIElements namespace contains elements that are defined as part of the Unity runtime. The UnityEditor.UIElements namespace contains elements that are available in the Unity Editor. To ful...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_962571bc7d99
unity_docs
rendering
Show me a Unity C# example demonstrating `LightTransport.InputExtraction.ComputeOcclusionLightIndicesFromBakeInput`.
osition. The returned indices are used with IProbeIntegrator.IntegrateOcclusion to compute shadow mask data for mixed lighting mode. Array Layout: For N probes and M lights per probe, the result contains N × M indices where indices [I × M to (I + 1) × M - 1] belong to probe i. Additional resources: IProbeIntegrator...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f6b47dd729bc
github
scripting
Write a Unity C# script called Angular Font Height Label
```csharp using UnityEngine.UIElements; namespace UIToolkitXRAdapter.AngularResizing.FontHeightOnlyTextElements { public sealed class AngularFontHeightLabel : Label, IAngularFontHeightTextElement<AngularFontHeightLabel> { // ReSharper disable once MemberCanBePrivate.Global // ReSharper disabl...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_56061816dc78
unity_docs
rendering
What is `Rendering.SortingSettings.criteria` in Unity? Explain its purpose and usage.
SortingSettings.criteria public Rendering.SortingCriteria criteria ; Description What kind of sorting to do while rendering. No sorting is set by default ( SortingCriteria.None ). Additional resources: SortingCriteria , DrawingSettings , ScriptableRenderContext.DrawRenderers.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e419e470f188
unity_docs
rendering
Explain 'Set a project’s color space' in Unity.
The Unity Editor offers both linear and gamma workflows. The linear workflow has a color space crossover where Textures that were authored in gamma color space can be correctly and precisely rendered in linear color space. See documentation on Linear rendering overview for more information about gamma and linear color ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bcb87ed739ee
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R8G8_SInt` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R8G8_SInt Description A two-component, 16-bit signed integer format that has an 8-bit R component in byte 0, and an 8-bit G component in byte 1.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_29715ef5776f
unity_docs
rendering
In Unity's 'Content output of a build', what is 'Player data compression options' and how does it work?
You can optionally compress Player data into an LZ4 ArchiveFile, by specifying BuildOptions.CompressWithLz4 . This is the same file format that Unity uses to archive AssetBundles. The compressed file for Player builds is always called data.unity3d and contains the global game managers ( globalgamemanagers ) serialized ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.