id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_man_31a7646f0d5a
unity_docs
editor
Explain 'The Simulator view' in Unity.
The Simulator view displays your application on a simulated mobile device. Use it to see how your application appears with the screen shape, resolution, and orientation of that device. ## Using the Simulator view To open the Simulator view, do one of the following: In the Game view , in the top left corner, use the d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_32c40c846e5c
unity_docs
rendering
In Unity's 'Choose a GPU texture format by platform', what is 'iOS and tvOS' and how does it work?
For Apple devices that use the A8 chip (2014) or above, ASTC is the recommended texture format for RGB and RGBA textures. This format allows you to choose between texture quality and size on a granular level: all the way from eight bits/pixel (4x4 block size) down to 0.89 bits/pixel (12x12 block size). If support for o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21936de056f3
unity_docs
rendering
What is `Rendering.LODParameters` in Unity? Explain its purpose and usage.
LODParameters struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description LODGroup culling parameters. Additional resources: CullingParameters. Properties Property Description cameraPixelHeight Rendering view height in pixels. cameraPosition Camera position. fieldOfView Camera's ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4625164687e3
unity_docs
math
What is `Rendering.RayTracingAABBsInstanceConfig.accelerationStructureBuildFlags` in Unity? Explain its purpose and usage.
RayTracingAABBsInstanceConfig.accelerationStructureBuildFlags public Rendering.RayTracingAccelerationStructureBuildFlags accelerationStructureBuildFlags ; Description The flags Unity uses when it builds the acceleration structure for the geometry referenced by this ray tracing instance configuration. If you s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16a718500eeb
unity_docs
physics
What is `XR.MeshGenerationStatus.Canceled` in Unity? Explain its purpose and usage.
MeshGenerationStatus.Canceled Description The mesh generation was canceled. This can happen if the XRMeshSubsystem is stopped or destroyed while meshes are being generated. No data is written to the Mesh or [[MeshCollider] provided during the call to XRMeshSubsystem.GenerateMeshAsync .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fa74069ab100
unity_docs
scripting
What is `Avatar.humanDescription` in Unity? Explain its purpose and usage.
Avatar.humanDescription public HumanDescription humanDescription ; Description Returns the HumanDescription used to create this Avatar. Note that an avatar created before 2019.1 returns an empty HumanDescription until the avatar is reimported.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a5889bb29b1c_doc_29
github
scripting
What does `GetHashCode` do in this Unity script? Explain its purpose and signature.
Hashes the contents of the brush.A hash code of the brush Signature: ```csharp public override int GetHashCode() ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_e6671072459f
unity_docs
physics
Explain 'Build for QNX from the command line' in Unity.
To build a Unity project for the QNX system on the command line interface (CLI), you must have the Unity Editor installed on the build host. The build host must be running a Linux operating system and also have the QNX SDK installed. For more information, refer to Install the Unity Editor for QNX . The following exampl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fedb9de2d763
unity_docs
rendering
What is `TextureWrapMode.MirrorOnce` in Unity? Explain its purpose and usage.
TextureWrapMode.MirrorOnce Description Mirrors the texture once, then clamps to edge pixels. This effectively mirrors the texture around zero UV coordinates, and repeats edge pixel values when outside of [-1..1] range. This mode is called "mirror and clamp to edge" in graphics APIs like Vulkan, Metal and OpenGL. Th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8f51c19b961
unity_docs
animation
Show me a Unity C# example demonstrating `AnimatorOverrideController.overridesCount`.
AnimatorOverrideController.overridesCount public int overridesCount ; Description Returns the count of overrides. ```csharp using System.Collections; using System.Collections.Generic; using UnityEngine;public class ResetOverrides : MonoBehaviour { public AnimatorOverrideController overrideController; protecte...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_16be876f1462
unity_docs
physics
In Unity's 'Conditional compilation in Unity', what is 'Conditionalattribute' and how does it work?
You can use the C# Conditional attribute which is a cleaner, less error-prone way of stripping out functions. For more information, refer to ConditionalAttribute Class . Common Unity callbacks such as Start() , Update() , LateUpdate() , FixedUpdate() , Awake() aren’t affected by this attribute because they’re called di...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fe9290824f98
unity_docs
ui
What is `UIElements.RadioButtonGroup.ctor` in Unity? Explain its purpose and usage.
RadioButtonGroup Constructor Declaration public RadioButtonGroup (); Description Initializes and returns an instance of RadioButtonGroup. Declaration public RadioButtonGroup (string label , List<string> radioButtonChoices ); Parameters Parameter Description label The label for this group radioButt...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9cb2189933db
github
scripting
Write a Unity C# script called UI Document Extensions
```csharp using System.Threading.Tasks; using UnityEngine; using UnityEngine.UIElements; namespace RMC.Mini.Samples.Login.WithMini.Mini { /// <summary> /// Helpful extensions for <see cref="UIDocument"/>. /// </summary> public static class UIDocumentExtensions { public static Sprite GetSpr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bae80aa5e40e
unity_docs
rendering
Explain 'Introduction to asynchronous shader compilation' in Unity.
Shader objects can contain of hundreds or thousands of shader variants . If the Editor compiled all variants when loading a Shader object, the import process would be very slow. Instead, the Editor compiles shader variants on-demand, the first time it encounters them. Compiling these shader variants can cause the Edito...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_da3aac0d5a34
unity_docs
math
What is `Rigidbody2D.MovePositionAndRotation` in Unity? Explain its purpose and usage.
Rigidbody2D.MovePositionAndRotation Declaration public void MovePositionAndRotation ( Vector2 position , float angle ); Parameters Parameter Description position The position to move the rigidbody to. angle The angle to move the rigidbody to. Description Moves the rigidbody position to position and t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bf9aaceea2ad
unity_docs
scripting
What is `Unity.Android.Gradle.ModuleBuildGradleFile.Android` in Unity? Explain its purpose and usage.
ModuleBuildGradleFile.Android public Unity.Android.Gradle.Android Android ; Description The C# definition of the android element in a gradle file. The main block that contains all Android-specific build options.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_784a8fdadf8b_doc_10
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The override URL pointing to a valid coverage tree binary file. Signature: ```csharp public string CoverageTreeManifestUrl; ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_061321b3d475
unity_docs
rendering
What is `Light.areaSize` in Unity? Explain its purpose and usage.
Light.areaSize public Vector2 areaSize ; Description The size of the area light. Rect lights: size of Area Light's rectangle. Disc lights: .x is the radius of the Disc light. Tube lights: .x is the length of the Tube light. Pyramid lights: .x is the aspect ratio. Additional resources: Light component .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3935f876023d
unity_docs
audio
What is `Networking.DownloadHandlerAudioClip` in Unity? Explain its purpose and usage.
DownloadHandlerAudioClip class in UnityEngine.Networking / Inherits from: Networking.DownloadHandler / Implemented in: UnityEngine.UnityWebRequestAudioModule Description A DownloadHandler subclass specialized for downloading audio data for use as AudioClip objects. DownloadHandlerAudioClip stores received...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5ba78e08708d
unity_docs
rendering
What is `Rendering.LightUnit.Nits` in Unity? Explain its purpose and usage.
LightUnit.Nits Description The unit of luminance (candela per square meter). Describes the surface power of a visible light source. When you use this unit, the overall power of a light source depends the size of the light source, meaning the the illumination level of a Scene changes depending on the size of the lig...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a9178eb26cb1
unity_docs
scripting
What is `Experimental.GraphView.SelectionDropper.RegisterCallbacksOnTarget` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. SelectionDropper.RegisterCallbacksOnTarget Declaration protected void RegisterCallbacksOnTarget (); Description Called to register click event callbacks on the target element.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e28331e30a4
unity_docs
math
What is `LightTransport.IProbeIntegrator.IntegrateDirectRadiance` in Unity? Explain its purpose and usage.
IProbeIntegrator.IntegrateDirectRadiance(IDeviceContext,int,int,int,BufferSlice<SphericalHarmonicsL2>) Parameters Parameter Description context Device context for computation and memory operations. positionOffset Starting index in the probe position buffer. positionCount Number of probe positions to process. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bcd5e837241d
unity_docs
math
What is `TerrainTools.BrushTransform.ToBrushUV` in Unity? Explain its purpose and usage.
BrushTransform.ToBrushUV Declaration public Vector2 ToBrushUV ( Vector2 targetXY ); Parameters Parameter Description targetXY Point in target XY space. Returns Vector2 Point transformed to Brush UV space. Description Applies the transform to convert a target XY coordinate to Brush UV space.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c7760b07a931
unity_docs
editor
What are the parameters of `EditorTools.ToolManager.SetActiveTool` in Unity?
Description Sets the active EditorTool . To set a built-in tool, such as Move, Rotate, or Scale, to active, use Tools.current instead. ```csharp using UnityEditor; using UnityEditor.EditorTools; using UnityEngine; class ToolToSetActive : EditorTool { [MenuItem("Tools/Set Active Tool Type")] static void SetActi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_656a355d17ce
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.AllowAutoRefresh`.
d does not simply enable the auto-refresh feature. Instead, it decrements a counter, and only allows auto-refresh when the counter reaches zero. It is designed to be used to re-enable auto-refresh after a call to AssetDatabase.DisallowAutoRefresh previously disabled it. Each time you call DisallowAutoRefresh, you must ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a72042f2f524
github
scripting
Write a Unity C# script called Sample Singleton
```csharp using BcoffeeDev.Patterns; using UnityEngine; namespace BcoffeeDev.Patterns.Samples { public class SampleSingleton : PersistentSingleton<SampleSingleton> { public void HelloWorld() { Debug.Log("Hello World."); } } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8aa9ebdd1ed0
unity_docs
ui
In Unity's 'Slider', what is 'Keyboard Shortcuts' and how does it work?
You can use keyboard shortcuts to navigate and adjust the Slider control. The following table lists the keyboard shortcuts: Shortcut Action Arrow Keys Move by 1/100 of the entire range. Arrow Keys + Shift Move by 1/10 of the entire range. Home Jump to the start of the slider. End Jump to the end of the slider. Page Up ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0d97edeeee3f
unity_docs
physics
What is `ShaderKeywordFilter.SelectIfAttribute` in Unity? Explain its purpose and usage.
SelectIfAttribute class in UnityEditor.ShaderKeywordFilter / Inherits from: ShaderKeywordFilter.FilterAttribute Description Include only the specified shader keywords in the build if the data field matches the condition. If the data field under SelectIf matches the value of condition , Unity includes only k...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f502b4fb58ba
unity_docs
rendering
What are the parameters of `Debug.LogException` in Unity?
Description A variant of Debug.Log that logs an exception message to the console. When you select the message in the Editor's console, the context object to which the message applies is highlighted in the Hierarchy window. You can click the hyperlinks in the stack trace to go directly to the relevant lines of code in y...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9d989fa91415
unity_docs
editor
What is `iOS.Xcode.PBXProject.AddFileToBuild` in Unity? Explain its purpose and usage.
PBXProject.AddFileToBuild Declaration public void AddFileToBuild (string targetGuid , string fileGuid ); Parameters Parameter Description targetGuid The GUID of the target, such as the one returned by GetUnityFrameworkTargetGuid . fileGuid The file GUID returned by AddFile or AddFolderReference . Des...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_51a78ce90e8f
unity_docs
editor
What are the parameters of `EditorGUILayout.BeginScrollView` in Unity?
Returns Vector2 The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. Description Begin an automatically laid out scrollview. These work just like GUILayout.BeginScrollView but feel more application-like and should be used in the editor Label inside a scroll view. ```csharp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5fd0dc7695b6
unity_docs
rendering
Show me a Unity C# example demonstrating `Shader.SetKeyword`.
termine which shader variants Unity uses. For information on working with local shader keywords and global shader keywords and how they interact, see Using shader keywords with C# scripts . When value is true , this function calls EnableKeyword . Otherwise, it calls DisableKeyword . The following example crea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_318075a30c77
unity_docs
rendering
What is `ParticleSystem.ShapeModule.randomDirectionAmount` in Unity? Explain its purpose and usage.
ParticleSystem.ShapeModule.randomDirectionAmount public float randomDirectionAmount ; Description Randomizes the starting direction of particles. This accepts values from 0 to 1, where 0 causes the particles to retain their default direction and 1 causes a completely random direction. Values in between 0 and 1...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1eb6b1db4499
github
scripting
Write a Unity C# script called Tetrimino View
```csharp using UnityEngine; using System.Collections.Generic; using TetrisEngine.TetriminosPiece; using System; using pooling; //This class represents a full tetris piece //Receives information from engine about the positions of the blocks and its color //Its a PoolingObject, so no object is deleted and few are crea...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_4421cd36fda5
unity_docs
scripting
What is `KeyCode.DownArrow` in Unity? Explain its purpose and usage.
KeyCode.DownArrow Description Down arrow key. Use this as a parameter to a function like Input.GetKey to detect when the user presses the down arrow key. Additional resources: Input.GetKey , Input.GetKeyDown , Input.GetKeyUp . ```csharp //Attach this to a GameObject //This script tells when the down arrow key...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0930b0193cd7
unity_docs
scripting
Explain 'Handle type data generically with Unity Properties' in Unity.
The Unity Properties API, in the Unity.Properties namespace, uses a visitor design pattern to visit .NET objects at runtime. Visiting objects allows you to discover and modify their properties and add new operations to an existing object structure at runtime without modifying the structure itself. You can build various...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3037849b6326
unity_docs
scripting
What is `UIElements.TransitionEventBase_1.AffectsProperty` in Unity? Explain its purpose and usage.
TransitionEventBase<T0>.AffectsProperty Declaration public bool AffectsProperty ( UIElements.StylePropertyName stylePropertyName ); Parameters Parameter Description stylePropertyName The property to check against. Returns bool true if the ITransitionEvent affects the specified property; otherwise, fal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e994631d0ff0
github
scripting
Write a Unity Editor script for Set Minimum Android Api Level Step
```csharp using System; using MagicLeap.SetupTool.Editor.Interfaces; using UnityEditor; using UnityEngine; namespace MagicLeap.SetupTool.Editor.Setup { public class SetMinimumAndroidApiLevelStep : ISetupStep { //Localization private const string MINIMUM_API_LEVEL_LABEL = "Set Minimum Android API Level"; privat...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_94dccef29d82
unity_docs
scripting
What is `Events.UnityEvent_2` in Unity? Explain its purpose and usage.
UnityEvent<T0,T1> class in UnityEngine.Events / Inherits from: Events.UnityEventBase / Implemented in: UnityEngine.CoreModule Description Two argument version of UnityEvent . Generics are supported, specify type parameters on initialization as shown in the example. Refer to Configure callbacks in the Inspec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_39826b2deb96
unity_docs
editor
In Unity's 'Search the Unity Editor main menu', what is 'Query syntax' and how does it work?
Provider token: m: Query example: List all menu commands related to splines, from all submenus. ``` m: splines ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_923ad3ff8d1c
unity_docs
scripting
What is `UIElements.StyleList_1` in Unity? Explain its purpose and usage.
StyleList<T0> struct in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Implements interfaces: IStyleValue<T0> Description Style value that can be either a list or a StyleKeyword . Properties Property Description keyword The style keyword. value The style value. Construct...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5115355314f6
unity_docs
editor
Explain 'Enable Unity Editor installation by standard users (Windows)' in Unity.
By default, installing Unity Editors is a process that requires administrator privileges. Starting with 2023.1, you can enable standard users on Windows to install Unity Editors without elevated privileges. ## Important considerations for third-party requirements Once enabled, this feature can reduce the administrato...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_52490aa4b3be
unity_docs
animation
What is `ModelImporter.motionNodeName` in Unity? Explain its purpose and usage.
ModelImporter.motionNodeName public string motionNodeName ; Description The path of the transform used to generation the motion of the animation. Path should look like this : "Reference/Root".
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e53606c639a1
unity_docs
ui
What is `UIElements.VisualElement.tooltip` in Unity? Explain its purpose and usage.
VisualElement.tooltip public string tooltip ; Description Text to display inside an information box after the user hovers the element for a small amount of time. This is only supported in the Editor UI.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4793a2f7aead
unity_docs
editor
What is `PrefabUtility.SavePrefabAsset` in Unity? Explain its purpose and usage.
PrefabUtility.SavePrefabAsset Declaration public static GameObject SavePrefabAsset ( GameObject asset ); Declaration public static GameObject SavePrefabAsset ( GameObject asset , out bool savedSuccessfully ); Parameters Parameter Description asset Any GameObject that is part of the Prefab Asset t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f0a08d42136c
unity_docs
scripting
What are the parameters of `Animator.SetFloat` in Unity?
Description Send float values to the Animator to affect transitions. Use SetFloat in a script to send float values to the Animator in order to activate transitions. In the Animator, define what values affect how certain animations transition. This is useful in various situations, especially in animation cycles such as ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_41e176ba30bd
unity_docs
ui
What is `SceneManagement.LoadSceneMode` in Unity? Explain its purpose and usage.
LoadSceneMode enumeration Description Used when loading a Scene in a player. Use LoadSceneMode to choose what type of Scene loads when using SceneManager.LoadScene . The available modes are Single and Additive. Single mode loads a standard Unity Scene which then appears on its own in the Hierarchy window. Additiv...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8c1a6bedff8c
unity_docs
ui
In Unity's 'RadioButton', what is 'Examples' and how does it work?
The following UXML example creates a RadioButton: ``` <UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements"> <GroupBox> <RadioButton label="UXML Field 1" name="the-uxml-field1" /> <RadioButton label="UXML Field 2" name="the-uxml-field2" /> </GroupBox> </UXML> ``` The following C# example illustrat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7ef8ed83989c
unity_docs
editor
What is `Search.SearchSelection` in Unity? Explain its purpose and usage.
SearchSelection class in UnityEditor.Search Description Provides methods to give readonly access to the current list of selected items in Search. ```csharp using UnityEngine; using UnityEditor; using UnityEditor.Search; static class Example_ISearchView_AddSelection { static ISearchView s_View; [MenuItem("Exam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4813d7e79da5
unity_docs
scripting
Show me a Unity C# example demonstrating `ReflectionProbe.clearFlags`.
ReflectionProbe.clearFlags public Rendering.ReflectionProbeClearFlags clearFlags ; Description How the reflection probe clears the background. Can be ReflectionProbeClearFlags.Skybox or ReflectionProbeClearFlags.SolidColor . ```csharp using UnityEngine; using System.Collections; public class ExampleScrip...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fb803731d193
unity_docs
rendering
Explain 'Texture Import Settings window reference' in Unity.
The Texture Import Settings window defines how Unity imports images from your project’s Assets folder into the Unity Editor. Page Description Texture type and shape settings reference Explore the properties in the top part of the Texture Import Settings window. Platform-specific texture overrides panel reference Explor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_81fe9890550c
unity_docs
performance
What is `LightTransport.ReferenceContext` in Unity? Explain its purpose and usage.
ReferenceContext class in UnityEngine.LightTransport Implements interfaces: IDeviceContext Description The ReferenceContext implements the IDeviceContext interface. The implementation favors correctness and simplicity over performance. It runs on CPU without multithreading, asynchronous execution or any othe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d5a47a580d5
unity_docs
animation
What is `ModelImporterClipAnimation.lockRootHeightY` in Unity? Explain its purpose and usage.
ModelImporterClipAnimation.lockRootHeightY public bool lockRootHeightY ; Description Enable to make vertical root motion be baked into the movement of the bones. Disable to make vertical root motion be stored as root motion.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_29e7abb614ee
unity_docs
physics
What are the parameters of `Collider.OnCollisionExit` in Unity?
Description OnCollisionExit is called when this collider/rigidbody has stopped touching another rigidbody/collider. In contrast to OnTriggerExit, OnCollisionExit is passed the Collision class and not a Collider. The Collision class contains information about contact points, impact velocity etc. If you don't use collisi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_112b94dc1c68
github
scripting
Write a Unity C# XR/VR script for XR Rig Floor Offset
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.XR; public class XRRigFloorOffset : MonoBehaviour { public float OffsetHeight = 1.69f; // Start is called before the first frame update void Start() { TrySetRoomScale(); } publ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_3c853a601953
unity_docs
scripting
What is `SpriteMask.frontSortingLayerID` in Unity? Explain its purpose and usage.
SpriteMask.frontSortingLayerID public int frontSortingLayerID ; Description Unique ID of the sorting layer defining the start of the custom range. Sprites sorted before this sorting layer will not be masked.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d428ff14f6f3
unity_docs
input
What is `Build.Player.PlayerBuildInterface.CompilePlayerScripts` in Unity? Explain its purpose and usage.
PlayerBuildInterface.CompilePlayerScripts Declaration public static Build.Player.ScriptCompilationResult CompilePlayerScripts ( Build.Player.ScriptCompilationSettings input , string outputFolder ); Description Compiles user scripts into one or more assemblies. Internal use only. See PlayerBuildInterface .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4ee6f17e852a
unity_docs
scripting
In Unity's 'MonoBehaviour', what is 'Content of a MonoBehaviour script file' and how does it work?
Double-click a script Asset in Unity to open it in a text editor. By default, Unity uses Visual Studio, but you can select any editor you like from the External Tools panel in Unity’s preferences (menu: Unity > Preferences ). If you choose to create a MonoBehaviour script, the initial contents of the file will look som...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_030e5456b12c
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.shape`.
ParticleSystem.shape public ParticleSystem.ShapeModule shape ; Description Script interface for the ShapeModule of a Particle System. Configures the initial positions and directions of particles. Particle System modules do not need to be reassigned back to the system; they are interfaces and not independent...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6acc8169bad9
unity_docs
scripting
Show me a Unity C# example demonstrating `LightTransport.IDeviceContext.ReadBuffer`.
operation. Use Flush to ensure the operation begins executing, then use Wait or IsCompleted with the provided event to determine when the transfer is complete. The destination NativeArray<T0> must remain allocated and unchanged until the read operation completes, as indicated by the event. Warning: EventID instanc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1cb29f1c313d
unity_docs
editor
What is `AssetDatabase.LoadObjectAsync` in Unity? Explain its purpose and usage.
AssetDatabase.LoadObjectAsync Declaration public static AssetDatabaseLoadOperation LoadObjectAsync (string assetPath , long localId ); Parameters Parameter Description assetPath Path of the asset to load. localId The local identifier of the object that you want to load. This allows you to load a specifi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_aa60b7d92c74
unity_docs
scripting
In Unity's 'Adding profiler markers to your code', what is 'Automatically close profiler marker code blocks' and how does it work?
Use ProfilerMarker.Auto to ensure that ProfilerMarker.End is automatically called at the end of the code block. The following calls are equivalent: ```csharp using Unity.Profiling; public class MySystemClass { static readonly ProfilerMarker k_UpdatePerfMarker = new ProfilerMarker("MySystem.Update"); public void Upd...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7c8210504e18
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUILayout.MaskField`.
ues passed 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 int The value modified by the user. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_51e00237b52a
unity_docs
editor
What are the parameters of `EditorGUI.FocusTextInControl` in Unity?
Description Move keyboard focus to a named text field and begin editing of the content. In Editor GUI, text fields can have keyboard focus without the text being edited. For example you may switch focus between text fields or other controls by using the up and down arrow keys. Once you click inside the text field, edit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a3bdb92aa7d2
unity_docs
editor
What is `PackageManager.Client.LogLevel` in Unity? Explain its purpose and usage.
Client.LogLevel public static PackageManager.LogLevel LogLevel ; Description Gets or sets the log level that the Package Manager uses when logging to the Editor.log and upm.log files. Defaults to LogLevel.Info . For a description of the different log levels, see the documentation for the LogLevel enum...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b4035d4a3d96
unity_docs
editor
What is `EditorStyles.inspectorFullWidthMargins` in Unity? Explain its purpose and usage.
EditorStyles.inspectorFullWidthMargins public static GUIStyle inspectorFullWidthMargins ; Description Wrap content in a vertical group with this style to get full width margins in the Inspector. By default, content in the Inspector has a large left margin and a small right margin. For a consistent look, these...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d6335fa8d81
unity_docs
math
What is `Vector3Int.operator_multiply` in Unity? Explain its purpose and usage.
Vector3Int.operator * public static Vector3Int operator * ( Vector3Int a , Vector3Int b ); public static Vector3Int operator * ( Vector3Int a , int b ); Description Multiplies a vector by a number.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5042861587b6
unity_docs
physics
What is `Physics.CheckCapsule` in Unity? Explain its purpose and usage.
Physics.CheckCapsule Declaration public static bool CheckCapsule ( Vector3 start , Vector3 end , float radius , int layerMask = DefaultRaycastLayers, QueryTriggerInteraction queryTriggerInteraction = QueryTriggerInteraction.UseGlobal); Parameters Parameter Description start The center of the spher...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_94c216cb2541_doc_12
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The exact prefix added to every question (including a new line).Returns an empty string if no prefix should be added. Signature: ```csharp public string usedFeedbackPrefix ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_a94c87ce60d7
unity_docs
rendering
Show me a Unity C# example demonstrating `Search.ShowDetailsOptions`.
ShowDetailsOptions enumeration Description Defines what details are shown in the preview inspector panel for the search view. . ``` [SearchItemProvider] internal static SearchProvider CreateProvider() { return new SearchProvider(id, name) { filterId = "hex:", priority = 99999, // put example provider at a low...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_258166f2baa7
unity_docs
rendering
What is `Rendering.RenderPipeline.BeginFrameRendering` in Unity? Explain its purpose and usage.
RenderPipeline.BeginFrameRendering Declaration protected static void BeginFrameRendering ( Rendering.ScriptableRenderContext context , Camera[] cameras ); Description Calls the RenderPipelineManager.beginFrameRendering delegate. This method is replaced by RenderPipeline.BeginContextRendering . It is suppo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_233b78341f46
unity_docs
xr
In Unity's 'Submit a license request from a command line and browser (Windows)', what is 'Procedure' and how does it work?
To manually activate your Unity license, follow these steps: Create a license request file (.alf ) from the command line. You must do this step from the computer where you installed Unity. Use that.alf file to generate a Unity license file (.ulf ) from Unity. You must do this step from any computer that has internet ac...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9cca86aa0177
unity_docs
scripting
What is `UIElements.ScrollView.nestedInteractionKind` in Unity? Explain its purpose and usage.
ScrollView.nestedInteractionKind public UIElements.ScrollView.NestedInteractionKind nestedInteractionKind ; Description The behavior to use when scrolling reaches limits of a nested ScrollView .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb2fa6fa10ad
unity_docs
math
What is `GridBrushBase.FloodFill` in Unity? Explain its purpose and usage.
GridBrushBase.FloodFill Declaration public void FloodFill ( GridLayout gridLayout , GameObject brushTarget , Vector3Int position ); Parameters Parameter Description gridLayout Grid used for layout. brushTarget Targets of flood fill operation. By default the currently selected GameObject. position ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_23a39c28445e
unity_docs
physics
What is `PhysicsVisualizationSettings.SetShowSphereColliders` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.SetShowSphereColliders Declaration public static void SetShowSphereColliders (bool show ); Description Should SphereColliders be shown. Additional resources: SphereCollider .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b232f6dd2727
unity_docs
editor
What are the parameters of `ObjectFactory.CreatePrimitive` in Unity?
Description Creates a GameObject primitive with Undo support. The created primitive will have any existing Preset applied to it, see Preset Manager . ```csharp using UnityEngine; using UnityEditor;public class CreatePrimitiveExample { [MenuItem("ObjectFactoryExample/Create Cube GameObject")] public void CreateC...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_67a8834a78ba
unity_docs
input
Show me a Unity C# example demonstrating `LocationService.Start`.
ssion instead. On WebGL, this method must be invoked as a response to a user gesture (such as a mouse click) within a coroutine. Note: Geolocation services are available only with an HTTPS connection, except during development when you might use http://localhost. The use of desiredAccuracyInMeters and updateDistan...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d8650dd3336a
unity_docs
scripting
Explain 'Use environment variables to identify your web proxy' in Unity.
If your environment doesn’t support automatic proxy configuration, you can use environment variables to identify your web proxy. HTTP_PROXY and HTTPS_PROXY are the environment variables you’ll use to identify your web proxy. If your enterprise uses a Unity Licensing Server, set the NO_PROXY environment variable as well...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4f323bfa2428
unity_docs
physics
In Unity's 'Handling variation in time', what is 'Limiting recorded time variation' and how does it work?
These values are also capped by the value of Time.maximumDeltaTime . The length of any pauses or variations in frame rate reported by these properties will never exceed Time.maximumDeltaTime . For example, if a delay of one second occurs, but maximumDeltaTime is set to the default value of 0.333, Time.time wonly increa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fb91dd4cf84c
unity_docs
rendering
Explain 'The Hierarchy window' in Unity.
View and manage all the objects in your scene . The Hierarchy window displays every GameObject in a scene, including models, cameras, and prefabs . You can use the Hierarchy window to manage and group the GameObjects you use in a Scene. When you add or remove GameObjects in the Scene view, you also add or remove them f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e557f8bc0b35
unity_docs
ui
What are the parameters of `UIElements.UQueryExtensions.Query` in Unity?
Returns UQueryBuilder<VisualElement> QueryBuilder configured with the associated selection rules. Description Initializes a QueryBuilder with the specified selection rules. Declaration public static UQueryBuilder<VisualElement> Query ( UIElements.VisualElement e , string name , string className ); Parameters Parameter ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_44dd4e8f1e4d
unity_docs
math
What is `PolygonCollider2D.SetPath` in Unity? Explain its purpose and usage.
PolygonCollider2D.SetPath Declaration public void SetPath (int index , Vector2[] points ); Parameters Parameter Description index Index of the path to set. points An ordered array of the vertices (points) that define the path. Description Define a path by its constituent points. A path is a cyclic se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2325c2dd6a55
unity_docs
editor
What is `Search.ISearchView.selection` in Unity? Explain its purpose and usage.
ISearchView.selection public Search.SearchSelection selection ; Description Returns the selected items in the view. ```csharp using UnityEngine; using UnityEditor; using UnityEditor.Search; static class Example_ISearchView_AddSelection { static ISearchView s_View; [MenuItem("Examples/ISearchView/AddSelect...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_73e6a5767f92
unity_docs
rendering
What is `Build.Content.SceneDependencyInfo` in Unity? Explain its purpose and usage.
SceneDependencyInfo struct in UnityEditor.Build.Content Description Scene dependency information generated from the ContentBuildInterface.PrepareScene API. 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 t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_644c56a49ae8
unity_docs
scripting
What is `Experimental.GraphView.Orientation` in Unity? Explain its purpose and usage.
Orientation enumeration Description Graph element orientation. Properties Property Description Horizontal Horizontal orientation used for nodes and connections flowing to the left or right. Vertical Vertical orientation used for nodes and connections flowing up or down.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2e64bb62bd92
unity_docs
input
In Unity's 'Hash128Field', what is 'Create a Hash128Field' and how does it work?
You can create a Hash128Field with UI Builder, UXML, or C#. The following C# example creates a Hash128Field with a Hash128 value: ``` var hash128Field = new Hash128Field(); hash128Field.label = "Label text:"; hash128Field.value = new Hash128(0x8f14e45f, 0xceea167a, 0x5a36dedd, 0x4bea2543); ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16592d6dad24
unity_docs
scripting
What is `ParticleSystem.CustomDataModule.SetVector` in Unity? Explain its purpose and usage.
ParticleSystem.CustomDataModule.SetVector Declaration public void SetVector ( ParticleSystemCustomData stream , int component , ParticleSystem.MinMaxCurve curve ); Parameters Parameter Description stream The name of the custom data stream to apply the curve to. component The component index to apply ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ba83f0ff5bb4
unity_docs
rendering
What is `Windows.WebCam.VideoCapture.GetSupportedFrameRatesForResolution` in Unity? Explain its purpose and usage.
VideoCapture.GetSupportedFrameRatesForResolution Declaration public static IEnumerable<float> GetSupportedFrameRatesForResolution ( Resolution resolution ); Parameters Parameter Description resolution A recording resolution. Returns IEnumerable<float> The frame rates at which the video can be recorded. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4e484b2f953a
unity_docs
scripting
What is `Experimental.GraphView.EdgeConnector_1.Abort` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeConnector<T0>.Abort Declaration protected void Abort (); Description Called when an edge creation is cancelled. This can happen when the edge is not dropped on a connector or when the escape key is pressed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6777f0800602
github
scripting
Write a Unity C# script called Addressable Array Assigner
```csharp using System; using UnityEngine; using UnityEngine.AddressableAssets; using UnityEngine.ResourceManagement.AsyncOperations; namespace PassivePicasso.SimplyAddress { [ExecuteAlways] public abstract class AddressableArrayAssigner<ComponentType, AssetType> : SimpleAddress where AssetType : UnityEngine....
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_e83beb902111
unity_docs
math
What is `Color32` in Unity? Explain its purpose and usage.
Color32 struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Representation of RGBA colors in 32 bit format. Each color component is a byte value with a range from 0 to 255. Components ( r , g , b ) define a color in RGB color space. Alpha component ( a ) defines transparency - alpha of 25...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_b3ed9f412a0e_doc_2
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The offset from the pointer to the pointer-mounted object in every frame. Signature: ```csharp private Vector3 pointerFrameOffset = Vector3.zero; ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_4d065a8ff99e
unity_docs
editor
In Unity's 'Use the Advanced Object Picker', what is 'Use the Advanced Object Picker in all reference fields' and how does it work?
To use the Advanced Object Picker in all reference fields in the Unity Editor: From the main menu, go to Edit > Preferences (macOS: Unity > Settings ). In the Preferences window, go to the Search tab. Under Search Engines , from the Object Selector dropdown, select Advanced . To revert to the default object selector, s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_63cf10de04f1
unity_docs
rendering
What is `Rendering.BatchDrawCommand.splitVisibilityMask` in Unity? Explain its purpose and usage.
BatchDrawCommand.splitVisibilityMask public ushort splitVisibilityMask ; Description Indicates which splits that the draw command is visible in. Unity uses this when it culls shadow map splits simultaneously. A split refers to a shadow cascade in a directional light shadow map or a cube map face in a point lig...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_40e17a3a5fdc
unity_docs
editor
What is `Device.SystemInfo.hdrDisplaySupportFlags` in Unity? Explain its purpose and usage.
SystemInfo.hdrDisplaySupportFlags public static HDRDisplaySupportFlags hdrDisplaySupportFlags ; Description This has the same functionality as SystemInfo.hdrDisplaySupportFlags and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6596f6193929
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.NoiseModule.octaveMultiplier`.
ParticleSystem.NoiseModule.octaveMultiplier public float octaveMultiplier ; Description When combining each octave, scale the intensity by this amount. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass : MonoBehaviour { private ParticleS...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80f9d15f1478
unity_docs
scripting
What is `Experimental.GraphView.GraphView.GetElementByGuid` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphView.GetElementByGuid Declaration public Experimental.GraphView.GraphElement GetElementByGuid (string guid ); Parameters Parameter Description guid The GUID. Returns GraphElement The first element with the give...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_df3b41518b13
unity_docs
audio
What is `AudioListener.pause` in Unity? Explain its purpose and usage.
AudioListener.pause public static bool pause ; Description The paused state of the audio system. If set to true, all AudioSources playing will be paused. This works in the same way as pausing the game in the editor. While the pause-state is true, the AudioSettings.dspTime will be frozen and further AudioSour...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a29ebf9ec0ff
unity_docs
scripting
What is `MonoBehaviour.StopCoroutine` in Unity? Explain its purpose and usage.
MonoBehaviour.StopCoroutine Declaration public void StopCoroutine (string methodName ); Declaration public void StopCoroutine (IEnumerator routine ); Declaration public void StopCoroutine ( Coroutine routine ); Parameters Parameter Description methodName Name of coroutine. routine Name of the f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_34306da38afc
unity_docs
scripting
What is `TerrainData.SetDetailScatterMode` in Unity? Explain its purpose and usage.
TerrainData.SetDetailScatterMode Declaration public void SetDetailScatterMode ( DetailScatterMode scatterMode ); Parameters Parameter Description detailScatterMode Sets the DetailScatterMode that specifies how to represent detail density at each sample of the detail resolution map. Description Sets the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.