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_4e7bf68e0046
unity_docs
xr
In Unity's 'Debug on Android devices', what is 'Connect via USB' and how does it work?
To connect an Android device to Unity through ADB using a USB: Enable ADB on the device. For information on how to do this, refer to Set up a device for development . Use a USB cable to connect your Android device to the machine running Unity. Navigate to File > Build Profiles . Select or add an Android build profile ....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9fb8d90ea835
unity_docs
editor
Explain 'Creating and accessing meshes via script' in Unity.
Resources and techniques for creating and configuring meshes. Topic Description Create a mesh Create a mesh in the Editor, in a 3D model, or via script. Access meshes via the Mesh API Use the Mesh API to build and configure meshes via script. Create a quad mesh via script Create and configure a quadrilateral mesh from ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c0626b546b3b
unity_docs
scripting
Explain 'Use Vector API to create a radial progress indicator' in Unity.
Version : 2023.2+ This example demonstrates how to create custom controls and use the Vector API to draw visual content onto a visual element . ## Example overview This example creates a custom control that displays progress, as an alternative to a loading bar. The progress indicator displays a progress value in a pa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0c9f12dc10a8
unity_docs
editor
In Unity's 'Search performance trackers', what is 'Provider filters' and how does it work?
The Performance Tracker provider has additional filters in the visual query builder , using standard search query operators . Filter Search token Query example Description Average (avg) perf: avg=<value> perf: avg<512kb Searches for performance trackers with an average value smaller than 512kb . Last time perf: lastTim...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0ef091923f46
unity_docs
rendering
What is `ImageConversion` in Unity? Explain its purpose and usage.
ImageConversion class in UnityEngine / Implemented in: UnityEngine.ImageConversionModule Description This class provides utility and extension methods to convert image data to and from PNG, JPEG and EXR formats, and to encode image data to TGA format. Static Properties Property Description EnableLegacyPngGam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f7d6e7c45206
unity_docs
animation
Show me a Unity C# example demonstrating `Animations.AnimationScriptPlayable.Create`.
able A new AnimationScriptPlayable linked to the PlayableGraph . Description Creates an AnimationScriptPlayable in the PlayableGraph . This playable contains a job implementing an IAnimationJob . This interface defines two methods that will be called while processing the PlayableGraph . Here is an exampl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_495c85b92884
unity_docs
rendering
In Unity's 'Use HLSL and ShaderLab in a compute shader', what is 'Use texture samplers' and how does it work?
Textures and samplers aren’t separate objects in Unity, so to use them in compute shaders you must follow one of the following Unity-specific rules: Use the same name as the Texture name, with sampler at the beginning (for example, Texture2D MyTex ; SamplerState samplerMyTex ). In this case, the sampler is initialized ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c18c64978398
unity_docs
scripting
In Unity's 'Get culling results', what is 'Receiving results via the onStateChanged callback' and how does it work?
The most efficient way to respond to spheres changing their visibility or distance state is to use the onStateChanged callback field. Set this to a function which takes a CullingGroupEvent structure as an argument; it will then be called after culling is complete, for each sphere that has changed state. The members of ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_77f37f483560
unity_docs
networking
Show me a Unity code example for 'Trusting the web proxy security certificate'.
web proxy software for details. Distribute the.pem file to each computer that has an instance of Unity. Define the NODE_EXTRA_CA_CERTS environment variable in a command file. Refer to Create a command file to set environment variables and open applications . ## Examples In the following examples, mycert.pem is the na...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_23a64a9d2843
unity_docs
rendering
Explain 'Audio Spatializer SDK' in Unity.
The audio spatializer SDK provides controls to change the way your application transmits audio from an audio source into the surrounding space. It is an extension of the native audio plugin SDK. The built-in panning of audio sources is a simple form of spatialization. It takes the source and regulates the gains of the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_340e51c70757_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A base class for MonoBehaviours that can beinstantiatedor addedto a with six arguments passed to the function of the created instance.Instances of classes inheriting from receive the arguments via the method where they can be assigned to member fields or properties. Type of the first argument received in the functi...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_f083a1fdf91c
unity_docs
editor
Show me a Unity C# example demonstrating `SerializedProperty.EqualContents`.
SerializedProperty.EqualContents Declaration public static bool EqualContents ( SerializedProperty x , SerializedProperty y ); Description See if contained serialized properties are equal. ```csharp using UnityEditor; using UnityEngine;public class EqualContentsExample : ScriptableObject { public int m_A ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dee17230096b
unity_docs
physics
What is `UIElements.VisualElement.MarkDirtyRepaint` in Unity? Explain its purpose and usage.
VisualElement.MarkDirtyRepaint Declaration public void MarkDirtyRepaint (); Description Triggers a repaint of the VisualElement on the next frame. This method is called internally when a change occurs that requires a repaint, such as when UIElements. BaseField_1.value is changed or the text in a Label . I...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_745f4ee9bb5c
unity_docs
networking
Explain 'Unity Services' in Unity.
Unity is more than an engine. It also brings a growing range of integrated services to engage, retain and monetize audiences. Unity provides a growing range of complimentary services to help developers make games and engage, retain and monetize audiences. Our Unity Ads, Unity Analytics , Unity Build Automation and Unit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2454fa024876
unity_docs
scripting
What is `UIElements.TypedUxmlAttributeDescription_1` in Unity? Explain its purpose and usage.
TypedUxmlAttributeDescription<T0> class in UnityEngine.UIElements / Inherits from: UIElements.UxmlAttributeDescription / Implemented in: UnityEngine.UIElementsModule Description Base class for all the UXML specific attributes. Properties Property Description defaultValue The default value to be used f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_38fe8d2c1b7f
unity_docs
audio
What is `AudioSource.mute` in Unity? Explain its purpose and usage.
AudioSource.mute public bool mute ; Description Un- / Mutes the AudioSource. Mute sets the volume=0, Un-Mute restore the original volume. ```csharp // Mutes-Unmutes the sound from this object each time the user presses space. using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b1b04aff2491
unity_docs
scripting
What is `AI.NavMeshLinkData.width` in Unity? Explain its purpose and usage.
NavMeshLinkData.width public float width ; Description If positive, the link will be rectangle aligned along the line from start to end. This allows paths to enter the link at any location along the end sides. If not positive, the link endpoints will be represented as points.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80574ea532fd
unity_docs
scripting
Show me a Unity C# example demonstrating `Camera.orthographicSize`.
hographic Camera. To edit orthographicSize , you must set the Camera projection to orthographic. The height of the viewing volume is ( orthographicSize * 2). Unity calculates the width of the viewing volume using orthographicSize and the camera's aspect . Unity ignores orthographicSize if the camera is not orth...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5e9a299d11e
unity_docs
editor
Give me an overview of the `NonReorderableAttribute` class in Unity.
NonReorderableAttribute class in UnityEngine / Inherits from: PropertyAttribute / Implemented in: UnityEngine.CoreModule Description Disables reordering of an array or list in the Inspector window. By default, array or list script variables are presented with a UI control that allows array element reordering ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_eba8466b9e94
unity_docs
ui
Show me a Unity code example for 'Bind to multiple properties with runtime binding'.
he data source when the UI changes. You can find the completed files that this example creates in this GitHub repository . ## Create a data source asset Create a data source asset that contains the properties you want to bind to. Create a project in Unity with any template. In the Assets folder of your project, creat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d02244447134
unity_docs
scripting
What are the parameters of `AI.NavMesh.CalculatePath` in Unity?
Returns bool True if either a complete or partial path is found. False otherwise. Description Calculate a path between two points and store the resulting path. Use this function to avoid gameplay delays by planning a path before it is needed. You can also use this function to check if a target position is reachable bef...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f74b93a84089
unity_docs
scripting
Show me a Unity C# example demonstrating `TextMesh.characterSize`.
TextMesh.characterSize public float characterSize ; Description The size of each character (This scales the whole text). ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { GetComponent<TextMesh>().characterSize = 10; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_55e644ce1cda
unity_docs
editor
Explain 'Search performance trackers' in Unity.
The Performance Trackers search provider searches the Profiler data of applications and the Unity Editor. For more information, refer to Collect performance data introduction . You can use the Performance Trackers search provider in two windows: In a dedicated window. From the main menu, select Window > Analysis > Perf...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cbc39dd425aa
unity_docs
rendering
What is `Rendering.ShadowSamplingMode` in Unity? Explain its purpose and usage.
ShadowSamplingMode enumeration Description Used by CommandBuffer.SetShadowSamplingMode . Properties Property Description CompareDepths Default shadow sampling mode: sampling with a comparison filter. RawDepth Shadow sampling mode for sampling the depth value. None In ShadowSamplingMode.None, depths are not c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_af6fdd484abc
unity_docs
scripting
Explain 'Pooling and reusing objects' in Unity.
Object pooling and reuse is a programming pattern that returns instances of frequently-used objects to a pool, from which they can be retrieved and used again. Object pooling reduces the overhead caused by repeatedly instantiating and destroying new object instances and limits the overall number of allocations and deal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_431903b3e5c6
unity_docs
rendering
Explain 'Scene templates introduction' in Unity.
To create new scenes, Unity copies a scene template, which is a pre-configured scene that contains all the content you want to start with. For example, the default Basic template usually contains a Camera and a light. You can create your own scene templates to customize the types of new scene you can create in a projec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d15cff5b7543
unity_docs
scripting
What is `TextMesh.characterSize` in Unity? Explain its purpose and usage.
TextMesh.characterSize public float characterSize ; Description The size of each character (This scales the whole text). ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { GetComponent<TextMesh>().characterSize = 10; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e6c25e053e4f
unity_docs
physics
What is `Build.OverrideTextureCompression` in Unity? Explain its purpose and usage.
OverrideTextureCompression enumeration Description Sets which texture compression override to use when importing assets. This enum is used by EditorUserBuildSettings.overrideTextureCompression . It lets you override the texture compression settings that Unity uses when it imports assets. This is mostly useful for...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c7aca0e163e
unity_docs
editor
What is `VersionControl.Provider.Merge` in Unity? Explain its purpose and usage.
Provider.Merge Declaration public static VersionControl.Task Merge ( VersionControl.AssetList assets ); Parameters Parameter Description assets The list of conflicting assets to be merged. Description Initiates a merge task to handle the merging of conflicting Assets. This invokes a merge tool, which yo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_494d42142592
unity_docs
scripting
What is `SceneTemplate.ISceneTemplatePipeline.IsValidTemplateForInstantiation` in Unity? Explain its purpose and usage.
ISceneTemplatePipeline.IsValidTemplateForInstantiation Declaration public bool IsValidTemplateForInstantiation ( SceneTemplate.SceneTemplateAsset sceneTemplateAsset ); Parameters Parameter Description sceneTemplateAsset A Scene Template asset that is available in New Scene dialog. Returns bool True if t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_267ffb582f8d
unity_docs
rendering
Show me a Unity C# example demonstrating `LineRenderer.widthCurve`.
LineRenderer.widthCurve public AnimationCurve widthCurve ; Description Set the curve describing the width of the line at various points along its length. This property is multiplied by LineRenderer.widthMultiplier to get the final width of the line. ```csharp using UnityEngine; using System.Collections;[R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c5468da185df
github
scripting
Write a Unity C# UI script for Warp Text Example
```csharp using UnityEngine; using System.Collections; namespace TMPro.Examples { public class WarpTextExample : MonoBehaviour { private TMP_Text m_TextComponent; public AnimationCurve VertexCurve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.25f, 2.0f), new Keyframe(0.5f, 0), ne...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
gh_ae89d0499561
github
scripting
Write a Unity C# MonoBehaviour script called Grab And Release
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; public class GrabAndRelease : MonoBehaviour { // Start is called before the first frame update void Start() { } // Update is called once per frame void Update() { } public vo...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_0fffddff393b
unity_docs
ui
What is `SceneManagement.LoadSceneMode.Single` in Unity? Explain its purpose and usage.
LoadSceneMode.Single Description Closes all current loaded Scenes and loads a Scene. Additional resources: SceneManager.LoadScene . ```csharp using UnityEngine; using UnityEngine.SceneManagement;public class Example : MonoBehaviour { void OnGUI() { //This displays a Button on the screen at position (20,30), w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7c0ac4056073
unity_docs
scripting
What is `UIElements.Toggle.noTextVariantUssClassName` in Unity? Explain its purpose and usage.
Toggle.noTextVariantUssClassName public static string noTextVariantUssClassName ; Description USS class name of Toggle elements that have no text. Unity adds this USS class to the Toggle if the Toggle does not have a label.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af2cfa05c449
unity_docs
ui
What is `UIElements.UsageHints.DynamicTransform` in Unity? Explain its purpose and usage.
UsageHints.DynamicTransform Description Optimizes rendering of a VisualElement for frequent position and transformation changes. This option uses the GPU instead of CPU to perform the VisualElement's vertex transformation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2ed38a64ba5e
unity_docs
scripting
In Unity's 'Configure mesh LOD', what is 'Configure project-wide LOD settings' and how does it work?
In the Quality settings window, you can configure LOD settings that affect all GameObjects in your Project. There are two LOD settings you can configure: Maximum LOD Level : Exclude meshes above a specified LOD level from your build. LOD Bias : Determine whether to favor higher or lower LOD levels at threshold distance...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eb435815b959
unity_docs
scripting
What are the parameters of `SortingLayer.GetLayerValueFromID` in Unity?
Returns int The final sorting value of the layer relative to other layers. Description Returns the final sorting layer value. To determine the sorting order between the various sorting layers, use this method to retrieve the final sorting value and use CompareTo to determine the order. ```csharp using UnityEngine;publi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0393a8d28be0
unity_docs
physics
In Unity's 'Conditional compilation in Unity', what is 'Assembly definition constraints' and how does it work?
The recommended approach for conditional compilation at a high level is to organize your scripts in assemblies with associated Assembly Definition files . If the code you want to conditionally include or exclude is in an assembly, you can configure Define Constraints on the assembly definition to, for example, only com...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1bd1fd40cff2
unity_docs
scripting
What is `UIElements.MultiColumnTreeView` in Unity? Explain its purpose and usage.
MultiColumnTreeView class in UnityEngine.UIElements / Inherits from: UIElements.BaseTreeView / Implemented in: UnityEngine.UIElementsModule Description A tree view with multi column support. For more information, refer to MultiColumnTreeView . Properties Property Description columns The collection of...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_839b72e835b0
unity_docs
scripting
What is `LowLevel.PlayerLoop.GetDefaultPlayerLoop` in Unity? Explain its purpose and usage.
PlayerLoop.GetDefaultPlayerLoop Declaration public static LowLevel.PlayerLoopSystem GetDefaultPlayerLoop (); Description Returns a Player loop system representing the default update order of all engine systems in Unity. The default update order is the order in which systems update unless you change it with S...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f5f26c5feefa
unity_docs
scripting
What is `Unity.Android.Gradle.Manifest.PathPermission` in Unity? Explain its purpose and usage.
PathPermission class in Unity.Android.Gradle.Manifest / Inherits from: Unity.Android.Gradle.Manifest.BaseElement Description The C# definition of the <path-permission> Android Manifest element. For more information about the element, see Android's documentation: PathPermission element Properties Property...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6a49cfeda733
unity_docs
animation
What is `Animations.AnimationStreamHandleUtility.ReadInts` in Unity? Explain its purpose and usage.
AnimationStreamHandleUtility.ReadInts Declaration public static void ReadInts ( Animations.AnimationStream stream , NativeArray<PropertyStreamHandle> handles , NativeArray<int> buffer ); Parameters Parameter Description stream The animation stream. handles The PropertyStreamHandle array to read from. b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e24c6fa0a2b4
unity_docs
scripting
What is `Awaitable_1` in Unity? Explain its purpose and usage.
Awaitable<T0> class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Custom Unity type that can be awaited and used as an async return type in the C# asynchronous programming model. Public Methods Method Description Cancel Cancel the awaitable. If the awaitable is being awaited, the awaite...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b7352f009c93
unity_docs
editor
Show me a Unity C# example demonstrating `Callbacks.RunAfterPackageAttribute`.
s a dependency graph and uses topological sorting to ensure that all dependencies are run in sequence based on their dependencies. If callbacks dependencies are not present in the project then the instruction will be ignored during the generation of the dependency graph. Note: Defining callback dependencies is current...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b9a9f914918
unity_docs
editor
What is `EditorGUI.PropertyField` in Unity? Explain its purpose and usage.
EditorGUI.PropertyField Declaration public static bool PropertyField ( Rect position , SerializedProperty property , bool includeChildren = false); Declaration public static bool PropertyField ( Rect position , SerializedProperty property , GUIContent label , bool includeChildren = false); Pa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e09f12f80e2
unity_docs
rendering
What is `Rendering.BatchRendererGroup.ctor` in Unity? Explain its purpose and usage.
BatchRendererGroup Constructor Declaration public BatchRendererGroup ( Rendering.BatchRendererGroup.OnPerformCulling cullingCallback , IntPtr userContext ); Declaration public BatchRendererGroup ( Rendering.BatchRendererGroupCreateInfo info ); Parameters Parameter Description cullingCallback Unity ca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5ffa7c3ce7a0
unity_docs
rendering
In Unity's 'ShaderLab: legacy alpha testing', what is 'Render pipeline compatibility' and how does it work?
Feature name Built-in Render Pipeline Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Custom SRP Legacy alpha testing Yes No No No After the final output color has been calculated, the color can optionally have its alpha value compared to a fixed value. If the test fails, the pixel is not written...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_18c674c60005
unity_docs
scripting
What are the parameters of `Pool.ObjectPool_1.Get` in Unity?
Returns PooledObject<T> A PooledObject that will return the instance back to the pool when its Dispose method is called. Description Returns a PooledObject that will automatically return the instance to the pool when it is disposed. ```csharp using System.Text; using UnityEngine; using UnityEngine.Pool;public class Exa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1b40c02f23da
github
scripting
Write a Unity C# script called MRTK Subsystem
```csharp // Copyright (c) Mixed Reality Toolkit Contributors // Licensed under the BSD 3-Clause using Unity.Profiling; using UnityEngine.SubsystemsImplementation; namespace MixedReality.Toolkit.Subsystems { /// <summary> /// A SubsystemWithProvider that supports Mixed Reality Toolkit lifecycle methods. /...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_dd01582fda36
unity_docs
scripting
Give me an overview of the `DelayedAttribute` class in Unity.
DelayedAttribute class in UnityEngine / Inherits from: PropertyAttribute / Implemented in: UnityEngine.CoreModule Description Attribute used to make a float, int, or string variable in a script be delayed. When this attribute is used, the float, int, or text field will not return a new value until the user ha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ac0dc5042a60
unity_docs
ui
Explain 'Import and preview video clips' in Unity.
Import, preview, and view source information of video clips in your application. A video clip asset is an imported video file, which you can reference in the Video Player component to play video content in your application. This information covers using video clip assets only. To use the Video Clip Importer, refer to V...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bac00aec5991
unity_docs
ui
What is `UIElements.VisualElement.paddingRect` in Unity? Explain its purpose and usage.
VisualElement.paddingRect protected Rect paddingRect ; Description The rectangle of the padding area of the element, in the local space of the element. In the box model used by UI Toolkit, the padding area refers to the inner rectangle. The inner rectangle includes the contentRect and padding, but exclud...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c52d573cabd8
unity_docs
rendering
In Unity's 'Use Animation curves', what is 'Add and modify keyframes' and how does it work?
You can add a keyframe at the currently previewed frame by clicking the Keyframe button . A keyframe can be added at the currently previewed frame by clicking the Keyframe button . This will add a keyframe to all currently selected curves. Alternatively you can add a keyframe to a single curve at any given frame by dou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3ff791bb63b3
unity_docs
ui
What is `UIElements.BaseVerticalCollectionView.ScrollTo` in Unity? Explain its purpose and usage.
BaseVerticalCollectionView.ScrollTo Declaration public void ScrollTo ( UIElements.VisualElement visualElement ); Parameters Parameter Description visualElement The element to scroll to. Description Scrolls to a specific VisualElement.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_308a59cfe44d
unity_docs
scripting
Explain 'Script serialization' in Unity.
Serialization is the automatic process of transforming data structures or GameObject states into a format that Unity can store and reconstruct later. How you organize data in your Unity project affects how Unity serializes that data, which can have a significant impact on the performance of your project. This page outl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_15cd3e38acf7
unity_docs
rendering
In Unity's 'Configure graphics tiers in the Built-In Render Pipeline', what is 'Using graphics tiers with C# scripts' and how does it work?
Unity stores the value of the current graphics tier in Graphics.activeTier , represented by a GraphicsTier enum. To add custom behavior based on the current graphics tier, you can test against this value. To override the value of Graphics.activeTier , set it directly. Note that you must do this before Unity loads any s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9bb2ad4a9005
unity_docs
scripting
What is `IMGUI.Controls.MultiColumnHeaderState.Column.maxWidth` in Unity? Explain its purpose and usage.
MultiColumnHeaderState.Column.maxWidth public float maxWidth ; Description Maximum width of the column. When resizing the column this is the maximum width which is allowed. Default value is 1000000 which basically means no upper limit.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d1c3d5d73bfe
unity_docs
input
Explain 'LongField' in Unity.
A LongField lets users input a numerical long integer value into an application. It accepts and displays text input. You can set placeholder text to provide hints or instructions to the user on what to enter. You can also add validation functions to ensure that the entered data meets certain requirements. Note : To ali...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_27973c2f28b2
unity_docs
ui
In Unity's 'Receive callbacks when a bound property changes', what is 'Example overview' and how does it work?
This example creates a custom Editor window with a TextField that binds to the name of a GameObject in a scene . If the name of the GameObject is GameObject , the background color of the text field label changes to dark red. You can find the completed files for the example in this GitHub repository .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_002707be5f08
unity_docs
rendering
What is `InSceneAssetUtility.IsInSceneAsset` in Unity? Explain its purpose and usage.
InSceneAssetUtility.IsInSceneAsset Declaration public static bool IsInSceneAsset ( Object sourceObject ); Parameters Parameter Description sourceObject The object to check. Returns bool True if sourceObject is a an in-scene asset. Description Checks if the given object is an in-scene asset. In-sc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_37c7db75b92e
unity_docs
physics
What is `Rigidbody2D.GetRelativeVector` in Unity? Explain its purpose and usage.
Rigidbody2D.GetRelativeVector Declaration public Vector2 GetRelativeVector ( Vector2 relativeVector ); Parameters Parameter Description relativeVector The local space vector to transform into a global space vector. Description Get a global space vector given the vector relativeVector in rigidBody loca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f379fcd9d51a
unity_docs
xr
What is `XR.XRSettings` in Unity? Explain its purpose and usage.
XRSettings class in UnityEngine.XR / Implemented in: UnityEngine.VRModule Description Global XR related settings. Static Properties Property Description deviceEyeTextureDimension Fetch the device eye texture dimension from the active stereo device. enabled Globally enables or disables XR for the application...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4676150b9443
unity_docs
rendering
Explain 'UWP Player settings' in Unity.
To access the Universal Windows Platform (UWP) Player settings, go to Edit > Project Settings > Player from the main menu in Unity. Use the Player settings to determine how Unity builds and displays your final application. For a description of the general Player settings, refer to Player Settings . Documentation for th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb9f58b16e8b
unity_docs
math
What is `UIElements.Painter2D.MoveTo` in Unity? Explain its purpose and usage.
Painter2D.MoveTo Declaration public void MoveTo ( Vector2 pos ); Parameters Parameter Description pos The position of the new sub-path. Description Begins a new sub-path at the provied coordinate.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_907db897148d
unity_docs
math
What is `Rendering.RayTracingInstanceCullingFlags.None` in Unity? Explain its purpose and usage.
RayTracingInstanceCullingFlags.None Description No flags are specified in RayTracingAccelerationStructure.CullInstances . This is the default parameters for RayTracingInstanceCullingConfig.flags .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7955b2c1e048
unity_docs
physics
What is `RaycastCommand.ScheduleBatch` in Unity? Explain its purpose and usage.
RaycastCommand.ScheduleBatch Declaration public static Unity.Jobs.JobHandle ScheduleBatch (NativeArray<RaycastCommand> commands , NativeArray<RaycastHit> results , int minCommandsPerJob , int maxHits , Unity.Jobs.JobHandle dependsOn ); Parameters Parameter Description commands A NativeArray of the Ra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_06488352bfc2
unity_docs
scripting
Explain 'Integrate Unity into Windows applications' in Unity.
You can use the Unity as a Library feature to integrate the Unity Runtime Library in Windows applications. This feature enables you to include Unity-powered features in your application, such as: 3D/2D Real-Time Rendering AR Experience 3D model interaction 2D mini-games The Unity Runtime Library exposes controls to man...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c8867989cca4
unity_docs
rendering
Explain 'Particle lights and trails' in Unity.
Understand how the Particle System can render lights and trails on particle effects. ## Lights The Lights module is a fast way to add real-time lighting to your particle effects. It can be used to make systems cast light onto their surroundings, for example for a fire, fireworks or lightning. It also allows you to ha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e895960638c4
unity_docs
scripting
Show me a Unity C# example demonstrating `Event.mousePosition`.
Event.mousePosition public Vector2 mousePosition ; Description The mouse position. Used in EventType.MouseMove and EventType.MouseDrag events. The top-left of the window returns (0, 0). The bottom-right returns (Screen.width, Screen.height). Additional resources: Event.delta . ```csharp using UnityEngin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_97e747864c81
unity_docs
scripting
In Unity's 'Create a randomized playlist with the Audio Random Container', what is 'From the Project view' and how does it work?
In the Unity Editor, do the following: Right click in the Project window to bring up the asset menu that contains a working menu item. Select Create . Select Audio . Select Audio Random Container . An empty Audio Random Container asset appears in the Project window under Assets .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f752fe744019
unity_docs
scripting
What is `AssetBundle.Contains` in Unity? Explain its purpose and usage.
AssetBundle.Contains Declaration public bool Contains (string name ); Description Check if an AssetBundle contains a specific object. Returns true if an Asset referred to by name is contained in the AssetBundle, false otherwise.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1963fbb7f930
unity_docs
editor
What is `MouseCursor.ResizeVertical` in Unity? Explain its purpose and usage.
MouseCursor.ResizeVertical Description Vertical resize arrows. ```csharp //Create a folder and name it “Editor” if this doesn’t already exist //Put this script in the folder//This script creates a new menu (“Examples”) and a menu item (“Mouse Cursor”). Click on this option. This displays a small window that has a c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ea590d3ede5a
unity_docs
scripting
What is `Search.SearchIndexer.timestamp` in Unity? Explain its purpose and usage.
SearchIndexer.timestamp public long timestamp ; Description Indicates when the search index was last modified. In example, this timestamp is used with the SearchMonitor.GetDiff function to gather all the changes that happened since the last time this index was modified.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8c51b1e01906
unity_docs
rendering
Explain 'Replace shaders at runtime in the Built-In Render Pipeline' in Unity.
In the Built-in Render Pipeline , you can tell a Camera to change the shader that it uses to render certain geometry at runtime. You might do this to achieve a visual effect such as edge detection. Shader replacement is done from scripts with either the Camera.RenderWithShader or Camera.SetReplacementShader function. B...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6bed90082637
unity_docs
scripting
What is `UIElements.StyleBackgroundSize` in Unity? Explain its purpose and usage.
StyleBackgroundSize struct in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Implements interfaces: IStyleValue<T0> Description Represents a style value that can be either a BackgroundSize or a StyleKeyword . Properties Property Description keyword The style keyword. value ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8fde5c4092ce
unity_docs
rendering
Show me a Unity C# example demonstrating `PlayerSettings.Android.textureCompressionFormats`.
r only) texture compression format to compress textures. In this case, you can override the target texture compression format using the EditorUserBuildSettings.androidBuildSubtarget property. You can't add the TextureCompressionFormat.BPTC or TextureCompressionFormat.Unknown options to texture compression formats...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a864a33c1a81_doc_0
github
scripting
What does `GenerateClass` do in this Unity script? Explain its purpose and signature.
Creates the text for the generated class that has the actualMenuItems.Text for the generated class Signature: ```csharp public static string GenerateClass() ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_845c12e83146
unity_docs
rendering
Explain 'Create a skybox' in Unity.
To create a new skybox material: From the main menu, select Assets > Create > Material . In the new material’s Inspector window, search for skybox in the Shader dropdown, then select a type of skybox shader. Configure the properties of the material to set up the skybox. The available properties depend on the type of sk...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5837033de07a
unity_docs
physics
What is `DynamicGI.updateThreshold` in Unity? Explain its purpose and usage.
DynamicGI.updateThreshold public static float updateThreshold ; Description Determines the percentage change in lighting intensity that triggers Unity to recalculate the real-time lightmap. Enlighten Realtime Global Illumination maintains a record of the cumulative percentage change in lighting intensity since...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3604b3123299
unity_docs
scripting
What is `Events.UnityEventTools.RegisterStringPersistentListener` in Unity? Explain its purpose and usage.
UnityEventTools.RegisterStringPersistentListener Declaration public static void RegisterStringPersistentListener ( Events.UnityEventBase unityEvent , int index , UnityAction<string> call , string argument ); Parameters Parameter Description unityEvent Event to modify. index Index to modify. call Func...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_eda4cf2292e9
unity_docs
rendering
In Unity's 'Root node reference', what is 'Distribution' and how does it work?
Property Function Tree Seed The randomizing seed for the tree. Change the seed to vary the tree’s procedural generation. Note that the seed from the root node changes the structure of the whole tree, including all branch groups, whereas seeds from a branch group change only that group. Area Spread The tree’s radius. Th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_95504ec76ffb
unity_docs
scripting
What is `Application.identifier` in Unity? Explain its purpose and usage.
Application.identifier public static string identifier ; Description Returns the application identifier at runtime. - On Apple platforms this is the 'bundleIdentifier' saved in the info.plist file. - On Android it's the 'package' from the AndroidManifest.xml. - On Universal Windows platform it's the 'Identit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bcabc7de9259
unity_docs
input
Give me an overview of the `AccelerationEvent` class in Unity.
AccelerationEvent struct in UnityEngine / Implemented in: UnityEngine.InputLegacyModule Description Structure describing acceleration status of the device. Properties Property Description acceleration Value of acceleration. deltaTime Amount of time passed since last accelerometer measurement.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b2ff4ed2fbf0
unity_docs
ui
What is `UIElements.IPointerEvent.pressedButtons` in Unity? Explain its purpose and usage.
IPointerEvent.pressedButtons public int pressedButtons ; Description Gets a bitmask that describes the buttons that are currently pressed. Pressing a mouse button sets a bit. Releasing the button clears the bit. The left mouse button sets/clears Bit 0. The right mouse button and pen barrel button set/clear...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9de773060e5
unity_docs
scripting
What is `Collision.collider` in Unity? Explain its purpose and usage.
Collision.collider public Collider collider ; Description The Collider we hit (Read Only). Fetch the Collider of the GameObject your GameObject hits. To find all colliders that were hit in detail you have to iterate the contact points ( contacts property). ```csharp //In this example, the name of the Game...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7d347b92134f
unity_docs
rendering
Explain 'Dedicated Server' in Unity.
Unity provides support for development of games and applications on the Dedicated Server platform. You can publish multiplayer games using Dedicated Server platform. Refer to the following sections to get started with development on Dedicated Server platform. Topic Description Introduction to Dedicated Server Introduce...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_82de05d80cf8
github
scripting
Write a Unity C# physics script for IK Legs
```csharp using UnityEngine; public class IKLegs : MonoBehaviour { private const float MAX_RAYCAST_DISTANCE = 2.5f; // Corresponds to default layer mask = Default private const int FLOOR_LAYER_MASK = 1; [Tooltip("The height offset added to the heel of the feet.")] [SerializeField] private flo...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_bb7c7a525fab
unity_docs
rendering
What are the parameters of `ScreenCapture.CaptureScreenshot` in Unity?
Description Captures a screenshot and saves it as a .png file to a specified path. If the screenshot exists already, ScreenCapture.CaptureScreenshot overwrites it with a new screenshot. Add .png to the end of filename to save the screenshot as a .png file. Mobile platforms (such as Android and iOS) : filename is append...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aebb2a1a8c14
unity_docs
scripting
What is `Compass.magneticHeading` in Unity? Explain its purpose and usage.
Compass.magneticHeading public float magneticHeading ; Description The heading in degrees relative to the magnetic North Pole. (Read Only) The value in this property is always measured relative to the top of the screen in its current orientation. The heading of magnetic north is not exactly the same as true g...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8684443c0c8b
unity_docs
scripting
Show me a Unity C# example demonstrating `MonoBehaviour.OnTransformChildrenChanged`.
called at runtime when a GameObject's direct children change. It can also be called in Edit mode if scripts use ExecuteInEditMode or ExecuteAlways . Use this callback to respond to changes in your GameObject's immediate child hierarchy, such as updating UI elements, managing child object lists, or refreshing cached ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6072bb542924
unity_docs
editor
What is `AssetDatabase.RemoveAssetBundleName` in Unity? Explain its purpose and usage.
AssetDatabase.RemoveAssetBundleName Declaration public static bool RemoveAssetBundleName (string assetBundleName , bool forceRemove ); Parameters Parameter Description assetBundleName The AssetBundle name you want to remove. forceRemove Flag to indicate if you want to remove the AssetBundle name even it's...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_38ee27ee23b1
unity_docs
physics
What is `Collider2D.callbackLayers` in Unity? Explain its purpose and usage.
Collider2D.callbackLayers public LayerMask callbackLayers ; Description The Layers that this Collider2D will report collision or trigger callbacks for during a contact with another Collider2D . When a contact occurs between two Collider2D , each Collider2D will get a collision or trigger callback. This ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_31755f542795
unity_docs
scripting
What is `Random.insideUnitSphere` in Unity? Explain its purpose and usage.
Random.insideUnitSphere public static Vector3 insideUnitSphere ; Description Returns a random point inside or on a sphere with radius 1.0 (Read Only). Note that the probability space includes the surface of the sphere because value , which is inclusive to 1.0, is used to acquire a random radius. ```csharp ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ed2ae817baf
unity_docs
animation
What is `AssetPostprocessor.OnPreprocessModel` in Unity? Explain its purpose and usage.
AssetPostprocessor.OnPreprocessModel() Description Add this function to a subclass to get a notification just before a model (.fbx, .mb file etc.) is imported. This lets you control the import settings through code. ```csharp using UnityEngine; using UnityEditor;// Disable import of materials if the file contains ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a92ea1619ccf
unity_docs
performance
Show me a Unity C# example demonstrating `Hash128.Append`.
val Input value. Description Hash new input data and combine with the current hash value. The value must be an "unmanaged" C# type. Primitive types like int, float, bool, enums, pointers, or structs containing primitive types are all unmanaged types. See Unmanaged types in C# language reference. The int and floa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e500d7f82537
unity_docs
scripting
Explain 'Search box' in Unity.
You can use the search box at the top of the list panel in the Package Manager window to find any packages or feature sets that match the text you enter. The Package Manager window updates the list as you enter search text, displaying every matching package or feature set for the context you’ve selected in the navigati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_69b439d67b4c
unity_docs
rendering
What are the parameters of `AssetDatabase.IsMainAssetAtPathLoaded` in Unity?
Returns bool Returns true if the main asset object at assetPath is loaded in memory. Description Checks whether the main asset object at assetPath is loaded in memory. All paths are relative to the Project folder, for example: "Assets/MyTextures/hello.png". Additional resources: AssetDatabase.LoadMainAssetAtPath , Reso...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1e8971117786
unity_docs
scripting
What is `Compilation.Assembly.ctor` in Unity? Explain its purpose and usage.
Assembly Constructor Declaration public Assembly (string name , string outputPath , string[] sourceFiles , string[] defines , Assembly[] assemblyReferences , string[] compiledAssemblyReferences , Compilation.AssemblyFlags flags ); Parameters Parameter Description name Assembly name. outputPath Asse...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4756ad13961c
unity_docs
rendering
In Unity's 'Safe Mode', what is 'Entering Safe Mode' and how does it work?
When you open a project which has compilation errors, the Editor displays a dialog to ask whether you want to enter Safe Mode: At this point you have three choices: Enter Safe Mode Ignore the errors and open your project Quit Unity In most cases, you should select Enter Safe Mode to resolve the errors in your project (...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.