id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_sr_cbd62c2c3bea
unity_docs
scripting
What is `CachedAssetBundle.hash` in Unity? Explain its purpose and usage.
CachedAssetBundle.hash public Hash128 hash ; Description Hash128 which is used as the version of the AssetBundle. The file will only be loaded from the cache if it has previously been downloaded with the same hash.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f7932846498c
unity_docs
scripting
What is `AndroidJNI.GetSuperclass` in Unity? Explain its purpose and usage.
AndroidJNI.GetSuperclass Declaration public static IntPtr GetSuperclass (IntPtr clazz ); Description If clazz represents any class other than the class Object , then this function returns the object that represents the superclass of the class specified by clazz . If clazz specifies the class Object , or...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4656293de0a8
unity_docs
audio
Explain 'Import audio files into Unity' in Unity.
Import audio files into your Unity project to include custom sounds in your Unity applications. For a list of the various audio file types Unity supports, refer to Audio file format compatibility . There are multiple ways to import an audio file into your Unity project. Choose one of the following: Import an audio file...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_360839abb917
github
scripting
Write a Unity C# script called Search With Filters
```csharp using FieldSearch.Core.Base; using FieldSearch.Core.Data.Criteria; using UnityEngine; namespace FieldSearch.Core { /// <summary> /// Default search with filters /// </summary> public class SearchWithFilters : BaseSearch { public SearchWithFilters(SearchFilter currentFlags) : base(currentFlags) { ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_00701657ebf3
unity_docs
editor
What is `EditorWindow.ShowAuxWindow` in Unity? Explain its purpose and usage.
EditorWindow.ShowAuxWindow Declaration public void ShowAuxWindow (); Description Show the editor window in the auxiliary window. The single auxiliary window can be re-used by different editor windows at different times. Showing an editor window in the auxiliary window can be useful to avoid clutter of many smal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d4e4b374824c
unity_docs
scripting
Explain 'Excluding hidden objects with occlusion culling' in Unity.
Resources about preventing Unity doing rendering calculations for hidden GameObjects . Note: If your project uses the Universal Render Pipeline (URP) or the High Definition Render Pipeline (HDRP), you can instead Enable GPU occlusion culling in URP or Enable GPU occlusion culling in HDRP . Page Description Occlusion cu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_231a39ddf6f5
unity_docs
editor
In Unity's 'Package states and lifecycle', what is 'Release track' and how does it work?
When a package passes quality testing and contains no experimental features or functionality (including dependencies on experimental packages), it enters the Pre-release state, which is on the release track. Unity fully supports packages on the release track and commits to officially releasing them by the end of the cu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_beb06f547cf7
unity_docs
scripting
What is `SettingsService.RepaintAllSettingsWindow` in Unity? Explain its purpose and usage.
SettingsService.RepaintAllSettingsWindow Declaration public static void RepaintAllSettingsWindow (); Description Notifies the SettingsService that all open Settings windows must be repainted. Call this function to refresh the Settings windows after external changes to the settings.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a5c05946572
unity_docs
rendering
What is `LightProbeProxyVolume.boundingBoxMode` in Unity? Explain its purpose and usage.
LightProbeProxyVolume.boundingBoxMode public LightProbeProxyVolume.BoundingBoxMode boundingBoxMode ; Description The bounding box mode for generating the 3D grid of interpolated Light Probes.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5b23493bc8b3
unity_docs
editor
In Unity's 'Pointer events', what is 'Unique properties' and how does it work?
altitudeAngle : The altitudeAngle contains the angle of the stylus relative to the surface, in radians. A value of 0 indicates that the stylus is parallel to the surface. A value of pi/2 indicates that it’s perpendicular to the surface. azimuthAngle : The azimuthAngle contains the angle of the stylus relative x-axis, i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_acdf0f8c7472
unity_docs
xr
In Unity's 'Refund a customer', what is 'Request a refund' and how does it work?
To request a refund from the Asset Store on the customer’s behalf: Go to the Asset Store support center . Enter the following information: Field Information Your email address Enter the business email address you use for your publisher account. Subject The name of your request. For example, Request for an Asset Store r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e24de78099fa
unity_docs
math
What is `AndroidJNI.NewStringUTF` in Unity? Explain its purpose and usage.
AndroidJNI.NewStringUTF Declaration public static IntPtr NewStringUTF (string bytes ); Description Constructs a new java.lang.String object from an array of characters in modified UTF-8 encoding. Additional resources: Java Native Interface Specification (Oracle)
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0d99f0ce7355
unity_docs
scripting
What is `Quaternion.y` in Unity? Explain its purpose and usage.
Quaternion.y public float y ; Description Y component of the Quaternion. Don't modify this directly unless you know quaternions inside out. ```csharp //Create three Sliders (Create>UI>Slider) and three Text GameObjects (Create>UI>Text). These are for manipulating the x, y, and z values of the Quaternion. The t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e9bce5b4176d
unity_docs
scripting
Explain 'Animation window' in Unity.
Use the Animation window to preview, create, and modify animation clips assigned to a GameObject . You can also use the Animation window to add Animation Events to an animation clip . An Animation Event calls a function at a specific time.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f53292df930d
unity_docs
input
What is `Experimental.GraphView.SelectionDragger.OnMouseUp` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. SelectionDragger.OnMouseUp Declaration protected void OnMouseUp ( UIElements.MouseUpEvent evt ); Parameters Parameter Description e The event. Description Called on mouse up event.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_60ab7150bdb2
unity_docs
rendering
In Unity's 'UI Builder interface overview', what is 'Hierarchy' and how does it work?
The Hierarchy pane contains the tree view representing the element hierarchy of the current document. It’s a superset of the hierarchy you see in the UXML text representation of the UI Document (UXML). Besides the elements created directly from UXML, the Hierarchy pane also contains elements created dynamically that on...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7c3bf91d86a5
unity_docs
xr
What are the parameters of `iOS.Xcode.PBXProject.AddAssetTagForFile` in Unity?
Description Adds an asset tag for the given file. The asset tags identify resources that are downloaded via On Demand Resources functionality. A request for a specific tag initiates the download of all files, configured for that tag. ```csharp using UnityEngine; using UnityEditor; using System.IO; using UnityEditor.Cal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f6a5c27f36b
unity_docs
animation
Give me an overview of the `HumanTrait` class in Unity.
HumanTrait class in UnityEngine / Implemented in: UnityEngine.AnimationModule Description Details of all the human bone and muscle types defined by Mecanim. Static Properties Property Description BoneCount The number of human bone types defined by Mecanim. BoneName Array of the names of all human bone types...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_01878247a724
unity_docs
scripting
What is `AI.NavMeshDataInstance.owner` in Unity? Explain its purpose and usage.
NavMeshDataInstance.owner public Object owner ; Description Get or set the owning Object. If the instance is invalid: setting the owner has no effect and getting it will return null. Additional resources: NavMeshAgent.navMeshOwner .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_30fca95663e3
unity_docs
editor
Show me a Unity C# example demonstrating `EditorUserBuildSettings.SwitchActiveBuildTargetAsync`.
ript code for the given target, which can't be done while script code is executing. This isn't a problem in the Editor, because the operation is deferred to the next Editor update. However, in batch mode the Editor stops after executing the designated script code, so deferring the operation isn't possible. To set the b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0ef59d49346f
unity_docs
rendering
Explain 'Occlusion culling' in Unity.
Occlusion culling is a process which prevents Unity from performing rendering calculations for GameObjects that are completely hidden from view (occluded) by other GameObjects. Every frame, Cameras perform culling operations that examine the Renderers in the Scene and exclude (cull) those that do not need to be drawn. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c29a9bf63cc7
unity_docs
scripting
What is `Search.SearchExpressionContext.ThrowError` in Unity? Explain its purpose and usage.
SearchExpressionContext.ThrowError Declaration public void ThrowError (string message ); Declaration public void ThrowError (string message , stringView errorPosition ); Description Stop a SearchExpression evaluation by throwing a SearchExceptionEvaluatorException. User writing an evaluator can decide t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8cd1df915b1
unity_docs
scripting
What is `PlayerSettings.GetDynamicBatchingForPlatform` in Unity? Explain its purpose and usage.
PlayerSettings.GetDynamicBatchingForPlatform Declaration public static bool GetDynamicBatchingForPlatform ( BuildTarget platform ); Parameters Parameter Description platform BuildTarget to check if dynamic batching is enabled for. Returns bool Is dynamic batching enabled for the BuildTarget. Descrip...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_071ec90b6c96
github
scripting
Write a Unity C# script called Screen Space Ambient Obscurance
```csharp using System; using UnityEngine; namespace UnityStandardAssets.ImageEffects { [ ExecuteInEditMode] [RequireComponent (typeof(Camera))] [AddComponentMenu ("Image Effects/Rendering/Screen Space Ambient Obscurance")] class ScreenSpaceAmbientObscurance : PostEffectsBase { [Range ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_ff0164dafb9a
unity_docs
scripting
Give me an overview of the `VideoEncodeAspectRatio` class in Unity.
VideoEncodeAspectRatio enumeration Description Methods to compensate for aspect ratio discrepancies between the source resolution and the wanted encoding size. Properties Property Description NoScaling Perform no operation. Stretch Stretch the source to fill the target resolution without preserving the aspect ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7dddf7719c3e
unity_docs
rendering
In Unity's 'Create a Custom Render Texture', what is 'Chaining Custom Render Textures' and how does it work?
You can chain Custom Render Textures together. To do this, use a Custom Render Texture as the input for a material that you have assigned to the Material or Initialization Mode > Texture in another Custom Render Texture. You can use chained Custom Render Textures to generate a simulation with multiple steps. Chained Cu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_34652714f7ab
unity_docs
scripting
Show me a Unity C# example demonstrating `iOS.Device.systemVersion`.
Device.systemVersion public static string systemVersion ; Description iOS version. iOS version as a string. E.g. "7.0" or "8.1". ```csharp using UnityEngine; using UnityEngine.iOS;public class SystemVersionExample : MonoBehaviour { bool allowFeature = true; void Start() { // Get the iOS version of the devic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fe677fc1e607
unity_docs
audio
In Unity's 'Introduction to the Audio Source component', what is 'Audio resources' and how does it work?
The Audio Source component requires an audio resource to play sound in your scene. Audio resources are containers that hold the actual audio data, so you must assign one to the Audio Source so it has audio data to edit and play. For instructions, refer to Assign an audio resource to your audio source . The following Un...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_850ce786772f
unity_docs
rendering
Give me an overview of the `SystemInfo` class in Unity.
SystemInfo class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Access system and hardware information. Use this class to figure out capabilities of the underlying platform and hardware. For example, you can check which RenderTexture formats are supported ( SupportsRenderTextureFormat ), ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cc95700f80bb
unity_docs
input
Give me an overview of the `TouchType` class in Unity.
TouchType enumeration Description Describes whether a touch is direct, indirect (or remote), or from a stylus. Properties Property Description Direct A direct touch on a device. Indirect An Indirect, or remote, touch on a device. Stylus A touch from a stylus on a device.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3319ea76ece3
unity_docs
animation
What is `Animations.PropertyStreamHandle.IsResolved` in Unity? Explain its purpose and usage.
PropertyStreamHandle.IsResolved Declaration public bool IsResolved ( Animations.AnimationStream stream ); Parameters Parameter Description stream The AnimationStream that holds the animated values. Returns bool Returns true if the handle is resolved, false otherwise. Description Returns whethe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9218699b1d92
unity_docs
rendering
Explain 'Creating shaders with Shader Graph' in Unity.
Shader Graph is a tool that enables you to build shaders visually. Instead of writing code, you create and connect nodes in a graph framework. Shader Graph gives instant feedback that reflects your changes, and it’s simple enough for users who are new to shader creation. ## Render pipeline compatibility Feature Unive...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_832c31c01050
unity_docs
xr
What is `SubsystemManager.beforeReloadSubsystems` in Unity? Explain its purpose and usage.
SubsystemManager.beforeReloadSubsystems Description Called from SubsystemManager before reloading all XR SDK Provider packaged subsystems. When the Editor starts or when packages are installed or removed, the SubsystemManager searches the packages and loads all XR SDK packages that it finds. Handling this event...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6fe59a076ed3
unity_docs
rendering
What is `MaterialEditor.GetTexturePropertyCustomArea` in Unity? Explain its purpose and usage.
MaterialEditor.GetTexturePropertyCustomArea Declaration public Rect GetTexturePropertyCustomArea ( Rect position ); Parameters Parameter Description position The total rect of the texture property. Description Returns the free rect below the label and before the large thumb object field. Is used for e.g...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a6e44e079ad
unity_docs
scripting
What is `MonoBehaviour.OnDrawGizmosSelected` in Unity? Explain its purpose and usage.
MonoBehaviour.OnDrawGizmosSelected() Description Implement OnDrawGizmosSelected to draw a gizmo if the object is selected. Gizmos are drawn only when the object is selected. Gizmos are not pickable. This is used to ease setup. For example an explosion script could draw a sphere showing the explosion radius. ``...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_581e37588488
unity_docs
scripting
What is `ProjectWindowCallback.EndNameEditAction` in Unity? Explain its purpose and usage.
EndNameEditAction class in UnityEditor.ProjectWindowCallback / Inherits from: ScriptableObject Description Base class to implement callbacks to be used when creating assets via the project window. You can extend the EndNameEditAction and write your own callback. Public Methods Method Description Action Unity...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7368a706c82c
unity_docs
scripting
What is `Rigidbody.PublishTransform` in Unity? Explain its purpose and usage.
Rigidbody.PublishTransform Declaration public void PublishTransform (); Description Applies the position and rotation of the Rigidbody to the corresponding Transform component. This is more efficient than setting Transform.position and Transform.rotation manually. Note: This method doesn't update the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d292502bb0e
unity_docs
math
Show me a Unity C# example demonstrating `Mesh.SetSubMeshes`.
hDescriptor-bounds , SubMeshDescriptor-firstVertex and SubMeshDescriptor-vertexCount values of SubMeshDescriptor are calculated automatically by SetSubMeshes , unless MeshUpdateFlags.DontRecalculateBounds flag is passed. Note that this only applies to the bounds of the SubMesh. You must call Mesh.RecalculateB...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_169d7aae24c4
unity_docs
scripting
Show me a Unity C# example demonstrating `Mesh.ctor`.
Mesh Constructor Declaration public Mesh (); Description Creates an empty Mesh. ```csharp // Create a new Mesh and assign it to the Mesh filter using UnityEngine;public class ExampleClass : MonoBehaviour { void Start() { Mesh mesh = new Mesh(); GetComponent<MeshFilter>().mesh = mesh; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f24a1776404e
unity_docs
audio
What is `AudioSource.isVirtual` in Unity? Explain its purpose and usage.
AudioSource.isVirtual public bool isVirtual ; Description True if all sounds played by the AudioSource, such as main sound started by Play() or playOnAwake, and one-shots are culled by the audio system. A sound is culled when its resulting volume is lower than the volumes of the N loudest voices, where N is th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_31482d21254f
unity_docs
rendering
What is `Renderer.rayTracingAccelerationStructureBuildFlagsOverride` in Unity? Explain its purpose and usage.
Renderer.rayTracingAccelerationStructureBuildFlagsOverride public bool rayTracingAccelerationStructureBuildFlagsOverride ; Description Whether to override the default build flags specified when creating a RayTracingAccelerationStructure . If you set this value to true , Unity uses Renderer.rayTracingAccelera...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b64c374a1176
unity_docs
animation
Show me a Unity C# example demonstrating `AnimationMode`.
n selected the example window will change. Choose a created animation clip for the chosen GameObject. Once the animation clip has been loaded the animation can be applied to the GameObject. Clicking the Animate button adds a slider to the window. Using the slider will apply the animation to the selected GameObject. The...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d4c86d30bf63
unity_docs
editor
What is `EditorGUI.showMixedValue` in Unity? Explain its purpose and usage.
EditorGUI.showMixedValue public static bool showMixedValue ; Description Makes the following controls give the appearance of editing multiple different values. This is sometimes useful when creating custom editors and you want to represent a value in a non-standard way in the GUI while also supporting multi-obj...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6cab31c752ea
unity_docs
scripting
What is `Search.SearchExpressionEvaluationHints.DoNotValidateArgsSignature` in Unity? Explain its purpose and usage.
SearchExpressionEvaluationHints.DoNotValidateArgsSignature Description Specifies that the evaluator signature shouldn't be validated by the SearchExpression runtime thus allowing any number of parameters with any types to be passed to the evaluator. It becomes the job of the evaluator itself to validate its parame...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_748903601c36
unity_docs
rendering
What are the parameters of `LightTransport.InputExtraction.PopulateWorld` in Unity?
Returns bool True if world population completed successfully, false if errors occurred. Description Converts extracted scene data into optimized data structures for light transport calculations. This method transforms the raw scene data from BakeInput into optimized data structures suitable for ray tracing and light in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1fc188ad9b5d
unity_docs
rendering
Explain 'Graphics' in Unity.
Use the Graphics settings (main menu: Edit > Project Settings , then select the Graphics category) to apply global settings for Graphics. When you build your project, the values of these settings become static. You can’t change the settings at runtime. This section provides documentation on the following groups of prop...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f829e6c142ef
unity_docs
scripting
What is `Search.QueryListBlock` in Unity? Explain its purpose and usage.
QueryListBlock class in UnityEditor.Search / Inherits from: Search.QueryBlock Description A query list block represents a special query block that will list a set of value for a given filter. In example, if your SearchProvider has a filter named color for which the value can be yellow, red or pink. Then you...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f146982434bc
unity_docs
editor
Show me a Unity C# example demonstrating `EditorUtility.OpenFilePanel`.
he Assets directory when this dialog opens. extension The file extensions to filter in this dialog. Do not precede file extension names with a period. Enter an empty string to include all file types. Separate multiple file extensions with a comma. Description Displays the "open file" dialog and returns the selected...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cbb2767ebd12
unity_docs
scripting
Show me a Unity C# example demonstrating `Video.VideoClip.originalPath`.
ormat. For example, if you do the following: Import an MP4 video file into Unity. Click on the file to show the Import Settings window. Enable Transcode . Set Codec to VP8 . Unity imports the video file in the WebM format, and originalPath returns .webm instead of .mp4 . To get your original format instead,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a710f1cc9b0e
unity_docs
scripting
What is `UIElements.ConverterGroup` in Unity? Explain its purpose and usage.
ConverterGroup class in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description A type to hold information about a conversion registry used locally on bindings. You can apply converter groups on a DataBinding in UXML with the source-to-ui-converters or ui-to-source-converters...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1e6a7cbd99cf
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.ForceOverLifetimeModule.y`.
ParticleSystem.ForceOverLifetimeModule.y public ParticleSystem.MinMaxCurve y ; Description The curve defining particle forces in the y-axis. Additional resources: MinMaxCurve . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass : MonoB...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d7d02d93015a
unity_docs
scripting
What is `TrueTypeFontImporter.ascentCalculationMode` in Unity? Explain its purpose and usage.
TrueTypeFontImporter.ascentCalculationMode public AscentCalculationMode ascentCalculationMode ; Description Calculation mode for determining font's ascent. Determines which calculation mode to use to determine the font's ascent when importing the font.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8ee0537509fb
unity_docs
rendering
Explain 'Upgrade Unity' in Unity.
Visit these pages for information about upgrading to later versions of the Unity Editor. Follow the instructions in each upgrade guide in release order. For example, if you need to upgrade your project from 2020 to 2022, read the 2021 upgrade guide to check if there are any changes that you need to make before you foll...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_03c160931b79
unity_docs
scripting
What is `Rendering.BlendShapeBufferLayout` in Unity? Explain its purpose and usage.
BlendShapeBufferLayout enumeration Description Determines the data that Unity returns when you call Mesh.GetBlendShapeBuffer . When you call Mesh.GetBlendShapeBuffer , you can access one of two buffers containing blend shape vertices. Use this value to determine which buffer to access. The default is BlendShape...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d174f632bea6
unity_docs
editor
Give me an overview of the `ApplicationInstallMode` class in Unity.
ApplicationInstallMode enumeration Description Application installation mode (Read Only). Properties Property Description Unknown Application install mode unknown. Store Application installed via online store. DeveloperBuild Application installed via developer build. Adhoc Application installed via ad hoc di...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b4ee136ecacb
unity_docs
editor
What is `IMGUI.Controls.AdvancedDropdown` in Unity? Explain its purpose and usage.
AdvancedDropdown class in UnityEditor.IMGUI.Controls Description Inherit from this class to implement your own drop-down control. ```csharp using UnityEditor; using UnityEngine; using UnityEditor.IMGUI.Controls;class WeekdaysDropdown : AdvancedDropdown { public WeekdaysDropdown(AdvancedDropdownState state) : bas...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7a6686e67731
unity_docs
scripting
Explain 'Awaitable completion and continuation' in Unity.
The await operator suspends execution of the enclosing async method, which allows the calling thread to perform other work while waiting. When the awaited Task or Awaitable completes, the asynchronous code needs to resume and continue its execution from the point it was suspended. How asynchronous code resumes can have...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6b1fa93d6e3a
unity_docs
rendering
Explain 'Creating a material from a prebuilt shader' in Unity.
The Standard shader allows for many configurations in order to represent a great variety of material types. Values can be set with texture maps or colour pickers and sliders. Generally UV mapping is required in conjunction with textures to describe which part of your mesh refers to which part of the texture map. The St...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86859edce1ac
unity_docs
input
What is `Input.simulateMouseWithTouches` in Unity? Explain its purpose and usage.
Input.simulateMouseWithTouches public static bool simulateMouseWithTouches ; Description Enables/Disables mouse simulation with touches. By default this option is enabled. Note : This API is part of the legacy Input Manager. The recommended best practice is that you don't use this API in new projects. For new p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_615f5057cd2c
unity_docs
editor
What is `SerializedProperty.enumNames` in Unity? Explain its purpose and usage.
SerializedProperty.enumNames public string[] enumNames ; Description Names of enumeration of an enum property. Additional resources: enumDisplayNames , propertyType , SerializedPropertyType.Enum , enumValueIndex . ```csharp using UnityEditor; using UnityEngine;public enum ExampleEnum { ValueFirst = 1, Va...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b14ff5b7c24c
unity_docs
rendering
In Unity's 'Fallback font', what is 'Fallback font usage' and how does it work?
In general, use fallback font assets to: Work with languages that have large alphabets, such as Chinese, Korean, and Japanese. Use fallback fonts to distribute an alphabet across several assets. Include special characters from other alphabets in your text. Tips : Dynamic OS font assets are great candidates for fallback...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_664cf6b2bed2
unity_docs
editor
In Unity's 'Registering an Action Handler', what is 'Contextual search actions' and how does it work?
To provide contextual (right-click) actions for specific types of items in search results, register an action named context for the Search Provider. The following example is from the Asset Search Provider: ``` new SearchAction(type, "context", null, "Context") { handler = (item, context) => { var asset = AssetDataba...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7011349108ab
unity_docs
rendering
What is `Rendering.BatchDrawCommandProcedural.splitVisibilityMask` in Unity? Explain its purpose and usage.
BatchDrawCommandProcedural.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...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d4d21c73780e
unity_docs
scripting
What is `Component.tag` in Unity? Explain its purpose and usage.
Component.tag public string tag ; Description The tag of this game object. A tag can be used to identify a game object. Tags must be declared in the Tags and Layers manager before using them. Note: You should not set a tag from the Awake() or OnValidate() method. This is because the order in which compon...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_561292b02d89
unity_docs
scripting
Show me a Unity C# example demonstrating `Transform.root`.
Transform.root public Transform root ; Description Returns the topmost transform in the hierarchy. (This never returns null, if this Transform doesn't have a parent it returns itself.) ```csharp using UnityEngine;public class Example : MonoBehaviour { // Is a collision between two objects with different ro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7e09f4ac897f
unity_docs
editor
Explain 'IL2CPP scripting back end' in Unity.
The IL2CPP (Intermediate Language To C++) scripting back end is an alternative to Mono that compiles code ahead-of-time (AOT) and supports a wider range of platforms. Topic Description Introduction to IL2CPP Understand IL2CPP’s role in Unity script compilation and how it works. IL2CPP runtime code checks Configure IL2C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8120d5d4ce8
unity_docs
scripting
Give me an overview of the `HighlightSearchMode` class in Unity.
HighlightSearchMode enumeration Description Used to specify how to find a given element in the editor to highlight. Let's consider various approaches to highlighting the Scale control in the Transform component. Using the HighlightSearchMode.PrefixLabel mode you can specify the label text "Scale" as the identifi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8752b04b4280
unity_docs
ui
What is `UIElements.VisualElement.TryGetLastBindingToSourceResult` in Unity? Explain its purpose and usage.
VisualElement.TryGetLastBindingToSourceResult Declaration public bool TryGetLastBindingToSourceResult (ref UIElements.BindingId bindingId , out UIElements.BindingResult result ); Parameters Parameter Description bindingId The ID of the binding object. result The result of the last binding operation to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e5f31efb79aa
unity_docs
scripting
Explain 'Using Unity as a Library in other applications' in Unity.
Unity as a Library is intended for specialist users who use native platform technologies such as Java/Android, Objective C/iOS, or Windows Win32/UWP, and want to include Unity-powered features in their games or applications. This documentation assumes that you have experience with developing for native platform technol...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b1caec0a8fa6
unity_docs
input
What is `Unity.IntegerTime.DiscreteTimeTimeExtensions.Floor` in Unity? Explain its purpose and usage.
DiscreteTimeTimeExtensions.Floor Declaration public static Unity.IntegerTime.DiscreteTime Floor ( Unity.IntegerTime.DiscreteTime x ); Parameters Parameter Description x The input. Returns DiscreteTime The result of rounding a DiscreteTime value up to the nearest integral value less or equal to the ori...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ab0db8e28112
unity_docs
editor
In Unity's 'Contents of the Asset Database', what is 'Source assets and artifacts' and how does it work?
On import, Unity converts most asset types from their original format to one optimized for use at runtime. The original file is referred to as the source asset and its imported counterpart is called an artifact. Unity converts source asset files to artifacts to make them easier to author within the Editor and easier fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9b914677d5aa
unity_docs
ui
What is `EditorStyles.toolbar` in Unity? Explain its purpose and usage.
EditorStyles.toolbar public static GUIStyle toolbar ; Description Toolbar background from top of windows. The toolbar is used as a background for other toolbar elements Additional resources: toolbarButton , toolbarPopup , toolbarDropDown .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0c0c9eefe8a1
unity_docs
scripting
In Unity's 'License troubleshooting', what is 'Issues with returning licenses' and how does it work?
The following issues can cause error codes or other problems while returning your license: Issue Solution You can’t return your license because you can’t access the computer where your license was activated 1. Go to https://id.unity.com/ and log in with your Unity ID. 2. Select My Account > My Seats in the side menu. 3...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2bf38386e2b3
unity_docs
scripting
What is `AudioType.S3M` in Unity? Explain its purpose and usage.
AudioType.S3M Description The audio file you want to stream has the ScreamTracker 3 audio file format. Use this enumeration value to ensure the format type of the audio file has the ScreamTracker 3 audio file format. Use this audio type for files with the extension .s3m . If the audio file has a different format, U...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_525b5fd29a9f
unity_docs
editor
What is `Selection.objects` in Unity? Explain its purpose and usage.
Selection.objects public static Object[] objects ; Description The actual unfiltered selection from the Scene. All objects will be returned, including assets in projects. You can also assign objects to the selection. Additional resources: Selection.instanceIDs . Scriptable Wizard that lets you select GameObje...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8646a95e32da
unity_docs
physics
What is `ArticulationJointType` in Unity? Explain its purpose and usage.
ArticulationJointType enumeration Description The type of the joint that restricts movement of the two connected articulation bodies. Properties Property Description FixedJoint Fixed joint doesn't allow any relative movement of the connected bodies. PrismaticJoint Prismatic joint only allows relative translati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_77ff28188ab6
unity_docs
editor
What are the parameters of `EditorGUI.EnumPopup` in Unity?
Returns Enum The enum option that has been selected by the user. Description Makes an enum popup selection field. Takes the currently selected enum value as a parameter and returns the enum value selected by the user. Enum Popup in an Editor Window. ```csharp using UnityEditor; using UnityEngine; // Shows info of a Gam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_df10543a8503
unity_docs
editor
What is `UndoRedoInfo` in Unity? Explain its purpose and usage.
UndoRedoInfo struct in UnityEditor Description Additional resources: Undo.undoRedoEvent . Properties Property Description isRedo Indicates whether the UndoRedoEvent is an undo or redo event. isRedo is true if the event is a Redo event. undoGroup The undo group that the undo or redo event came from. undoName...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_83f7d7cd3535
unity_docs
editor
Show me a Unity C# example demonstrating `Profiling.HierarchyFrameDataView.GetItemMergedSamplesMetadata`.
t id , int sampleIndex , int metadataIndex ); Parameters Parameter Description id Hierarchy item identifier. sampleIndex Merged sample index. metadataIndex Metadata index. Returns string Returns value of the metadata as string. Description Returns string representation of hierarchy item metadata v...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bc8e0067a05f
unity_docs
scripting
What is `UIElements.ScrollView.horizontalVariantContentUssClassName` in Unity? Explain its purpose and usage.
ScrollView.horizontalVariantContentUssClassName public static string horizontalVariantContentUssClassName ; Description USS class name that's added when the ContentContainer is in horizontal mode.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_138b740ab6b1
unity_docs
scripting
What is `VideoClipImporter.GetResizeWidth` in Unity? Explain its purpose and usage.
VideoClipImporter.GetResizeWidth Declaration public int GetResizeWidth ( VideoResizeMode mode ); Parameters Parameter Description mode Mode for which the width is queried. Returns int Width for the specified resize mode. Description Get the resulting width of the resize operation for the specified r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c2a6a4cbf54
unity_docs
scripting
What is `Rendering.RenderTargetBinding` in Unity? Explain its purpose and usage.
RenderTargetBinding struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Describes a render target with one or more color buffers, a depth/stencil buffer and the associated load/store-actions that are applied when the render target is active. This data structure is similiar to R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d9e436ba7413
unity_docs
scripting
In Unity's 'Unity programming best practices', what is 'Avoid C# finalizers' and how does it work?
Don’t use C# finalizers in runtime code, for the following reasons: They run on separate finalizer threads and Unity APIs usually require the main thread. They run non-determinisitically, leading to unpredictable behavior. They might not run at all, unless the application garbage collects and waits. Exceptions thrown f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b97c22aace0
unity_docs
scripting
What is `ShortcutManagement.ShortcutBinding.ToString` in Unity? Explain its purpose and usage.
ShortcutBinding.ToString Declaration public string ToString (); Returns string The string representation of the current ShortcutBinding value. Description Converts the value of the current ShortcutBinding object to its equivalent string representation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4a967f24295e
unity_docs
rendering
Show me a Unity code example for 'Simple diffuse lighting shader example in the Built-In Render Pipeline'.
orks by rendering the main directional light, ambient, lightmaps and reflections in a single pass called ForwardBase . In the shader, this is indicated by adding a pass tag : Tags {“LightMode”=“ForwardBase”} . This will make directional light data be passed into shader via some built-in variables . Here’s the shader th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_37a2054320f3
unity_docs
scripting
What is `SearchService.ObjectSelectorSearchContext.visibleObjects` in Unity? Explain its purpose and usage.
ObjectSelectorSearchContext.visibleObjects public SearchService.VisibleObjects visibleObjects ; Description Indicates which categories of objects are visible in the window. For example, GameObjects, Assets, or both. Additional resources: VisibleObjects .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0b3c93cda9e9
unity_docs
rendering
What is `Material` in Unity? Explain its purpose and usage.
Material class in UnityEngine / Inherits from: Object / Implemented in: UnityEngine.CoreModule Description The material class. This class exposes all properties from a material, allowing you to animate them. You can also use it to set custom shader properties that can't be accessed through the inspector (e.g...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6eefee28d52e
unity_docs
animation
Explain 'Animator Override Controller' in Unity.
Use an Animator Override Controller asset to override the animation clips in an Animator Controller while retaining the structure, parameters, and logic of its state machine . You can use this technique to create many variations of the same Animator Controller. For example, your game has different characters such as a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab35f47b83e0
unity_docs
scripting
What are the parameters of `EditorGUILayout.Space` in Unity?
Description Make a small space between the previous control and the following. Custom inspector that shows the X,Y,Z,W quaternion components of a transform. ```csharp // Create a custom transform inspector that shows the X,Y,Z,W quaternion components // instead of the rotation angles.using UnityEditor; using UnityEngin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3dbf59645296
unity_docs
editor
Show me a Unity C# example demonstrating `iOS.Xcode.PBXProject.WriteToString`.
PBXProject.WriteToString Declaration public string WriteToString (); Returns string The project contents converted to string. Description Writes the contents of the project to string. ```csharp using UnityEditor; using System.IO; using UnityEditor.Callbacks; using UnityEditor.iOS.Xcode;public class Sample...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c55b220e3133
unity_docs
rendering
Show me a Unity code example for 'Surface Shader output structures in the Built-In Render Pipeline'.
Standard output structure of surface shaders is this: ``` struct SurfaceOutput { fixed3 Albedo; // diffuse color fixed3 Normal; // tangent space normal, if written fixed3 Emission; half Specular; // specular power in 0..1 range fixed Gloss; // specular intensity fixed Alpha; // alpha for transparencies }; ``` In ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_35f8fb3212ea_doc_6
github
scripting
What does `OnPointerUp` do in this Unity script? Explain its purpose and signature.
Handle pointer/touch release: toggle the state and invoke appropriate events.This is where the actual toggle happens - the state flips on release, not on press. Signature: ```csharp public override void OnPointerUp(PointerEventData eventData) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_60a1f8ad9a61
unity_docs
ui
In Unity's 'Introduction to USS', what is 'Syntax' and how does it work?
The following is the general syntax of a style rule: ``` selector { property1: value; property2: value; } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b8bfe36b5657
unity_docs
rendering
Show me a Unity C# example demonstrating `Search.SearchUtils.GetHierarchyAssetPath`.
ration public static string GetHierarchyAssetPath ( GameObject gameObject , bool prefabOnly ); Parameters Parameter Description gameObject GameObject to find the scene path. prefabOnly If true, will return a path only if the GameObject is a prefab. Returns string Returns the path of a scene or prefab. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f3e2e0b6a962
unity_docs
scripting
In Unity's 'Enable optional features for QNX', what is 'Startup time logging' and how does it work?
Startup time logging is the length of time that it takes an application to start up. It’s often used as a critical metric for system safety and regulatory requirements. Startup time logging in QNX devices include the duration or total time from the time the application launches. There are two types of Startup time logg...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ecd3c5e3806d
unity_docs
scripting
Show me a Unity C# example demonstrating `Camera.usePhysicalProperties`.
Camera.usePhysicalProperties public bool usePhysicalProperties ; Description Enable usePhysicalProperties to use physical camera properties to compute the field of view and the frustum. The physical properties include the sensor size, lens shift, and focal length. ```csharp using UnityEngine;public class Ex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_697a3596c343
unity_docs
scripting
What is `ClipboardUtility.pastedGameObjects` in Unity? Explain its purpose and usage.
ClipboardUtility.pastedGameObjects Parameters Parameter Description value An array containing the GameObjects that were pasted. Description Event triggered after GameObjects are pasted from the clipboard.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_528fa0a0106b
unity_docs
ui
In Unity's 'Scroller', what is 'Create a Scroller' and how does it work?
You can create a Scroller with UI Builder, UXML, or C#. The following C# example creates a Scroller with a default value, low limit, and high limit, and sets the direction of the Scroller: ``` var scroller = new Scroller(); scroller.value = 42; scroller.lowValue = 0; scroller.highValue = 100; scroller.direction = Slide...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6306d8e038d0
unity_docs
rendering
What is `XR.XRDisplaySubsystem.GetRenderTexture` in Unity? Explain its purpose and usage.
XRDisplaySubsystem.GetRenderTexture Declaration public RenderTexture GetRenderTexture (uint unityXrRenderTextureId ); Parameters Parameter Description unityXrRenderTextureId The ID number identifying the render texture. Returns RenderTexture The managed UnityEngine.RenderTexture instance associated wit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_266f66e67a84
unity_docs
animation
Explain 'Introduction to the Asset Store' in Unity.
The Asset Store contains a library of free and commercial assets that Unity Technologies and members of the community create. A wide variety of assets are available, including textures, models, animations, entire project examples, tutorials, and extensions for the Unity Editor. ## Access the Asset Store You can acces...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.